juce_SortedSet.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_SORTEDSET_H_INCLUDED
#define JUCE_SORTEDSET_H_INCLUDED
 
#if JUCE_MSVC
 #pragma warning (push)
 #pragma warning (disable: 4512)
#endif
 
//==============================================================================
template <class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
class SortedSet
{
public:
    //==============================================================================
    SortedSet() noexcept
    {
    }
 
    SortedSet (const SortedSet& other)
        : data (other.data)
    {
    }
 
    ~SortedSet() noexcept
    {
    }
 
    SortedSet& operator= (const SortedSet& other) noexcept
    {
        data = other.data;
        return *this;
    }
 
    //==============================================================================
    bool operator== (const SortedSet<ElementType>& other) const noexcept
    {
        return data == other.data;
    }
 
    bool operator!= (const SortedSet<ElementType>& other) const noexcept
    {
        return ! operator== (other);
    }
 
    //==============================================================================
    void clear() noexcept
    {
        data.clear();
    }
 
    void clearQuick() noexcept
    {
        data.clearQuick();
    }
 
    //==============================================================================
    inline int size() const noexcept
    {
        return data.size();
    }
 
    inline ElementType operator[] (const int index) const noexcept
    {
        return data [index];
    }
 
    inline ElementType getUnchecked (const int index) const noexcept
    {
        return data.getUnchecked (index);
    }
 
    inline ElementType& getReference (const int index) const noexcept
    {
        return data.getReference (index);
    }
 
    inline ElementType getFirst() const noexcept
    {
        return data.getFirst();
    }
 
    inline ElementType getLast() const noexcept
    {
        return data.getLast();
    }
 
    //==============================================================================
    inline ElementType* begin() const noexcept
    {
        return data.begin();
    }
 
    inline ElementType* end() const noexcept
    {
        return data.end();
    }
 
    //==============================================================================
    int indexOf (const ElementType& elementToLookFor) const noexcept
    {
        const ScopedLockType lock (data.getLock());
 
        int s = 0;
        int e = data.size();
 
        for (;;)
        {
            if (s >= e)
                return -1;
 
            if (elementToLookFor == data.getReference (s))
                return s;
 
            const int halfway = (s + e) / 2;
 
            if (halfway == s)
                return -1;
 
            if (elementToLookFor < data.getReference (halfway))
                e = halfway;
            else
                s = halfway;
        }
    }
 
    bool contains (const ElementType& elementToLookFor) const noexcept
    {
        return indexOf (elementToLookFor) >= 0;
    }
 
    //==============================================================================
    bool add (const ElementType& newElement) noexcept
    {
        const ScopedLockType lock (getLock());
 
        int s = 0;
        int e = data.size();
 
        while (s < e)
        {
            ElementType& elem = data.getReference (s);
            if (newElement == elem)
            {
                elem = newElement; // force an update in case operator== permits differences.
                return false;
            }
 
            const int halfway = (s + e) / 2;
            const bool isBeforeHalfway = (newElement < data.getReference (halfway));
 
            if (halfway == s)
            {
                if (! isBeforeHalfway)
                    ++s;
 
                break;
            }
 
            if (isBeforeHalfway)
                e = halfway;
            else
                s = halfway;
        }
 
        data.insert (s, newElement);
        return true;
    }
 
    void addArray (const ElementType* elementsToAdd,
                   int numElementsToAdd) noexcept
    {
        const ScopedLockType lock (getLock());
 
        while (--numElementsToAdd >= 0)
            add (*elementsToAdd++);
    }
 
    template <class OtherSetType>
    void addSet (const OtherSetType& setToAddFrom,
                 int startIndex = 0,
                 int numElementsToAdd = -1) noexcept
    {
        const typename OtherSetType::ScopedLockType lock1 (setToAddFrom.getLock());
 
        {
            const ScopedLockType lock2 (getLock());
            jassert (this != &setToAddFrom);
 
            if (this != &setToAddFrom)
            {
                if (startIndex < 0)
                {
                    jassertfalse;
                    startIndex = 0;
                }
 
                if (numElementsToAdd < 0 || startIndex + numElementsToAdd > setToAddFrom.size())
                    numElementsToAdd = setToAddFrom.size() - startIndex;
 
                if (numElementsToAdd > 0)
                    addArray (&setToAddFrom.data.getReference (startIndex), numElementsToAdd);
            }
        }
    }
 
    //==============================================================================
    ElementType remove (const int indexToRemove) noexcept
    {
        return data.remove (indexToRemove);
    }
 
    void removeValue (const ElementType valueToRemove) noexcept
    {
        const ScopedLockType lock (getLock());
        data.remove (indexOf (valueToRemove));
    }
 
    template <class OtherSetType>
    void removeValuesIn (const OtherSetType& otherSet) noexcept
    {
        const typename OtherSetType::ScopedLockType lock1 (otherSet.getLock());
        const ScopedLockType lock2 (getLock());
 
        if (this == &otherSet)
        {
            clear();
        }
        else if (otherSet.size() > 0)
        {
            for (int i = data.size(); --i >= 0;)
                if (otherSet.contains (data.getReference (i)))
                    remove (i);
        }
    }
 
    template <class OtherSetType>
    void removeValuesNotIn (const OtherSetType& otherSet) noexcept
    {
        const typename OtherSetType::ScopedLockType lock1 (otherSet.getLock());
        const ScopedLockType lock2 (getLock());
 
        if (this != &otherSet)
        {
            if (otherSet.size() <= 0)
            {
                clear();
            }
            else
            {
                for (int i = data.size(); --i >= 0;)
                    if (! otherSet.contains (data.getReference (i)))
                        remove (i);
            }
        }
    }
 
    template <class OtherSetType>
    void swapWith (OtherSetType& otherSet) noexcept
    {
        data.swapWith (otherSet.data);
    }
 
    //==============================================================================
    void minimiseStorageOverheads() noexcept
    {
        data.minimiseStorageOverheads();
    }
 
    void ensureStorageAllocated (const int minNumElements)
    {
        data.ensureStorageAllocated (minNumElements);
    }
 
    //==============================================================================
    inline const TypeOfCriticalSectionToUse& getLock() const noexcept      { return data.getLock(); }
 
    typedef typename TypeOfCriticalSectionToUse::ScopedLockType ScopedLockType;
 
 
private:
    //==============================================================================
    Array<ElementType, TypeOfCriticalSectionToUse> data;
};
 
#if JUCE_MSVC
 #pragma warning (pop)
#endif
 
#endif   // JUCE_SORTEDSET_H_INCLUDED