SortedSet.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   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 ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC 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.
 
  ==============================================================================
*/
 
#ifndef WATER_SORTEDSET_H_INCLUDED
#define WATER_SORTEDSET_H_INCLUDED
 
#include "../water.h"
 
namespace water {
 
//==============================================================================
template <class ElementType>
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 bool isEmpty() const noexcept
    {
        return size() == 0;
    }

    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
    {
        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
    {
        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
    {
        while (--numElementsToAdd >= 0)
            add (*elementsToAdd++);
    }

    template <class OtherSetType>
    void addSet (const OtherSetType& setToAddFrom,
                 int startIndex = 0,
                 int numElementsToAdd = -1) noexcept
    {
        wassert (this != &setToAddFrom);
 
        if (this != &setToAddFrom)
        {
            if (startIndex < 0)
            {
                wassertfalse;
                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.removeAndReturn (indexToRemove);
    }

    void removeValue (const ElementType valueToRemove) noexcept
    {
        data.remove (indexOf (valueToRemove));
    }

    template <class OtherSetType>
    void removeValuesIn (const OtherSetType& otherSet) noexcept
    {
        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
    {
        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);
    }
 
 
private:
    //==============================================================================
    Array<ElementType> data;
};
 
}
 
#endif // WATER_SORTEDSET_H_INCLUDED