JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | List of all members
SortedSet< ElementType, TypeOfCriticalSectionToUse > Class Template Reference

Holds a set of unique primitive objects, such as ints or doubles. More...

Public Types

typedef
TypeOfCriticalSectionToUse::ScopedLockType 
ScopedLockType
 Returns the type of scoped lock to use for locking this array.
 

Public Member Functions

 SortedSet () noexcept
 Creates an empty set.
 
 SortedSet (const SortedSet &other)
 Creates a copy of another set.
 
 ~SortedSet () noexcept
 Destructor.
 
SortedSetoperator= (const SortedSet &other) noexcept
 Copies another set over this one.
 
bool operator== (const SortedSet< ElementType > &other) const noexcept
 Compares this set to another one.
 
bool operator!= (const SortedSet< ElementType > &other) const noexcept
 Compares this set to another one.
 
void clear () noexcept
 Removes all elements from the set.
 
void clearQuick () noexcept
 Removes all elements from the set without freeing the array's allocated storage.
 
int size () const noexcept
 Returns the current number of elements in the set.
 
ElementType operator[] (const int index) const noexcept
 Returns one of the elements in the set.
 
ElementType getUnchecked (const int index) const noexcept
 Returns one of the elements in the set, without checking the index passed in.
 
ElementType & getReference (const int index) const noexcept
 Returns a direct reference to one of the elements in the set, without checking the index passed in.
 
ElementType getFirst () const noexcept
 Returns the first element in the set, or 0 if the set is empty.
 
ElementType getLast () const noexcept
 Returns the last element in the set, or 0 if the set is empty.
 
ElementType * begin () const noexcept
 Returns a pointer to the first element in the set.
 
ElementType * end () const noexcept
 Returns a pointer to the element which follows the last element in the set.
 
int indexOf (const ElementType &elementToLookFor) const noexcept
 Finds the index of the first element which matches the value passed in.
 
bool contains (const ElementType &elementToLookFor) const noexcept
 Returns true if the set contains at least one occurrence of an object.
 
bool add (const ElementType &newElement) noexcept
 Adds a new element to the set, (as long as it's not already in there).
 
void addArray (const ElementType *elementsToAdd, int numElementsToAdd) noexcept
 Adds elements from an array to this set.
 
template<class OtherSetType >
void addSet (const OtherSetType &setToAddFrom, int startIndex=0, int numElementsToAdd=-1) noexcept
 Adds elements from another set to this one.
 
ElementType remove (const int indexToRemove) noexcept
 Removes an element from the set.
 
void removeValue (const ElementType valueToRemove) noexcept
 Removes an item from the set.
 
template<class OtherSetType >
void removeValuesIn (const OtherSetType &otherSet) noexcept
 Removes any elements which are also in another set.
 
template<class OtherSetType >
void removeValuesNotIn (const OtherSetType &otherSet) noexcept
 Removes any elements which are not found in another set.
 
template<class OtherSetType >
void swapWith (OtherSetType &otherSet) noexcept
 This swaps the contents of this array with those of another array.
 
void minimiseStorageOverheads () noexcept
 Reduces the amount of storage being used by the set.
 
void ensureStorageAllocated (const int minNumElements)
 Increases the set's internal storage to hold a minimum number of elements.
 
const TypeOfCriticalSectionToUsegetLock () const noexcept
 Returns the CriticalSection that locks this array.
 

Detailed Description

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
class SortedSet< ElementType, TypeOfCriticalSectionToUse >

Holds a set of unique primitive objects, such as ints or doubles.

A set can only hold one item with a given value, so if for example it's a set of integers, attempting to add the same integer twice will do nothing the second time.

Internally, the list of items is kept sorted (which means that whatever kind of primitive type is used must support the ==, <, >, <= and >= operators to determine the order), and searching the set for known values is very fast because it uses a binary-chop method.

Note that if you're using a class or struct as the element type, it must be capable of being copied or moved with a straightforward memcpy, rather than needing construction and destruction code.

To make all the set's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.

See Also
Array, OwnedArray, ReferenceCountedArray, StringArray, CriticalSection

Member Typedef Documentation

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
typedef TypeOfCriticalSectionToUse::ScopedLockType SortedSet< ElementType, TypeOfCriticalSectionToUse >::ScopedLockType

Returns the type of scoped lock to use for locking this array.

Constructor & Destructor Documentation

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
SortedSet< ElementType, TypeOfCriticalSectionToUse >::SortedSet ( )
noexcept

Creates an empty set.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
SortedSet< ElementType, TypeOfCriticalSectionToUse >::SortedSet ( const SortedSet< ElementType, TypeOfCriticalSectionToUse > &  other)

Creates a copy of another set.

Parameters
otherthe set to copy
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
SortedSet< ElementType, TypeOfCriticalSectionToUse >::~SortedSet ( )
noexcept

Destructor.

Member Function Documentation

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
SortedSet& SortedSet< ElementType, TypeOfCriticalSectionToUse >::operator= ( const SortedSet< ElementType, TypeOfCriticalSectionToUse > &  other)
noexcept

Copies another set over this one.

Parameters
otherthe set to copy
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool SortedSet< ElementType, TypeOfCriticalSectionToUse >::operator== ( const SortedSet< ElementType > &  other) const
noexcept

Compares this set to another one.

Two sets are considered equal if they both contain the same set of elements.

Parameters
otherthe other set to compare with

Referenced by SortedSet< ColourSetting >::operator!=().

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool SortedSet< ElementType, TypeOfCriticalSectionToUse >::operator!= ( const SortedSet< ElementType > &  other) const
noexcept

Compares this set to another one.

Two sets are considered equal if they both contain the same set of elements.

Parameters
otherthe other set to compare with
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::clear ( )
noexcept

Removes all elements from the set.

This will remove all the elements, and free any storage that the set is using. To clear it without freeing the storage, use the clearQuick() method instead.

See Also
clearQuick

Referenced by SortedSet< ColourSetting >::removeValuesIn(), and SortedSet< ColourSetting >::removeValuesNotIn().

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::clearQuick ( )
noexcept

Removes all elements from the set without freeing the array's allocated storage.

See Also
clear
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int SortedSet< ElementType, TypeOfCriticalSectionToUse >::size ( ) const
noexcept

Returns the current number of elements in the set.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType SortedSet< ElementType, TypeOfCriticalSectionToUse >::operator[] ( const int  index) const
noexcept

Returns one of the elements in the set.

If the index passed in is beyond the range of valid elements, this will return zero.

If you're certain that the index will always be a valid element, you can call getUnchecked() instead, which is faster.

Parameters
indexthe index of the element being requested (0 is the first element in the set)
See Also
getUnchecked, getFirst, getLast
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType SortedSet< ElementType, TypeOfCriticalSectionToUse >::getUnchecked ( const int  index) const
noexcept

Returns one of the elements in the set, without checking the index passed in.

Unlike the operator[] method, this will try to return an element without checking that the index is within the bounds of the set, so should only be used when you're confident that it will always be a valid index.

Parameters
indexthe index of the element being requested (0 is the first element in the set)
See Also
operator[], getFirst, getLast
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType& SortedSet< ElementType, TypeOfCriticalSectionToUse >::getReference ( const int  index) const
noexcept

Returns a direct reference to one of the elements in the set, without checking the index passed in.

This is like getUnchecked, but returns a direct reference to the element, so that you can alter it directly. Obviously this can be dangerous, so only use it when absolutely necessary.

Parameters
indexthe index of the element being requested (0 is the first element in the array)
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType SortedSet< ElementType, TypeOfCriticalSectionToUse >::getFirst ( ) const
noexcept

Returns the first element in the set, or 0 if the set is empty.

See Also
operator[], getUnchecked, getLast
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType SortedSet< ElementType, TypeOfCriticalSectionToUse >::getLast ( ) const
noexcept

Returns the last element in the set, or 0 if the set is empty.

See Also
operator[], getUnchecked, getFirst
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType* SortedSet< ElementType, TypeOfCriticalSectionToUse >::begin ( ) const
noexcept

Returns a pointer to the first element in the set.

This method is provided for compatibility with standard C++ iteration mechanisms.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType* SortedSet< ElementType, TypeOfCriticalSectionToUse >::end ( ) const
noexcept

Returns a pointer to the element which follows the last element in the set.

This method is provided for compatibility with standard C++ iteration mechanisms.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int SortedSet< ElementType, TypeOfCriticalSectionToUse >::indexOf ( const ElementType &  elementToLookFor) const
noexcept

Finds the index of the first element which matches the value passed in.

This will search the set for the given object, and return the index of its first occurrence. If the object isn't found, the method will return -1.

Parameters
elementToLookForthe value or object to look for
Returns
the index of the object, or -1 if it's not found

Referenced by SortedSet< ColourSetting >::contains(), and SortedSet< ColourSetting >::removeValue().

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool SortedSet< ElementType, TypeOfCriticalSectionToUse >::contains ( const ElementType &  elementToLookFor) const
noexcept

Returns true if the set contains at least one occurrence of an object.

Parameters
elementToLookForthe value or object to look for
Returns
true if the item is found
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool SortedSet< ElementType, TypeOfCriticalSectionToUse >::add ( const ElementType &  newElement)
noexcept

Adds a new element to the set, (as long as it's not already in there).

Note that if a matching element already exists, the new value will be assigned to the existing one using operator=, so that if there are any differences between the objects which were not recognised by the object's operator==, then the set will always contain a copy of the most recently added one.

Parameters
newElementthe new object to add to the set
Returns
true if the value was added, or false if it already existed
See Also
set, insert, addIfNotAlreadyThere, addSorted, addSet, addArray

Referenced by SortedSet< ColourSetting >::addArray().

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::addArray ( const ElementType *  elementsToAdd,
int  numElementsToAdd 
)
noexcept

Adds elements from an array to this set.

Parameters
elementsToAddthe array of elements to add
numElementsToAddhow many elements are in this other array
See Also
add

Referenced by SortedSet< ColourSetting >::addSet().

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherSetType >
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::addSet ( const OtherSetType &  setToAddFrom,
int  startIndex = 0,
int  numElementsToAdd = -1 
)
noexcept

Adds elements from another set to this one.

Parameters
setToAddFromthe set from which to copy the elements
startIndexthe first element of the other set to start copying from
numElementsToAddhow many elements to add from the other set. If this value is negative or greater than the number of available elements, all available elements will be copied.
See Also
add
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ElementType SortedSet< ElementType, TypeOfCriticalSectionToUse >::remove ( const int  indexToRemove)
noexcept

Removes an element from the set.

This will remove the element at a given index. If the index passed in is out-of-range, nothing will happen.

Parameters
indexToRemovethe index of the element to remove
Returns
the element that has been removed
See Also
removeValue, removeRange
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::removeValue ( const ElementType  valueToRemove)
noexcept

Removes an item from the set.

This will remove the given element from the set, if it's there.

Parameters
valueToRemovethe object to try to remove
See Also
remove, removeRange
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherSetType >
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::removeValuesIn ( const OtherSetType &  otherSet)
noexcept

Removes any elements which are also in another set.

Parameters
otherSetthe other set in which to look for elements to remove
See Also
removeValuesNotIn, remove, removeValue, removeRange
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherSetType >
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::removeValuesNotIn ( const OtherSetType &  otherSet)
noexcept

Removes any elements which are not found in another set.

Only elements which occur in this other set will be retained.

Parameters
otherSetthe set in which to look for elements NOT to remove
See Also
removeValuesIn, remove, removeValue, removeRange
template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherSetType >
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::swapWith ( OtherSetType &  otherSet)
noexcept

This swaps the contents of this array with those of another array.

If you need to exchange two arrays, this is vastly quicker than using copy-by-value because it just swaps their internal pointers.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::minimiseStorageOverheads ( )
noexcept

Reduces the amount of storage being used by the set.

Sets typically allocate slightly more storage than they need, and after removing elements, they may have quite a lot of unused space allocated. This method will reduce the amount of allocated storage to a minimum.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void SortedSet< ElementType, TypeOfCriticalSectionToUse >::ensureStorageAllocated ( const int  minNumElements)

Increases the set's internal storage to hold a minimum number of elements.

Calling this before adding a large known number of elements means that the set won't have to keep dynamically resizing itself as the elements are added, and it'll therefore be more efficient.

template<class ElementType, class TypeOfCriticalSectionToUse = DummyCriticalSection>
const TypeOfCriticalSectionToUse& SortedSet< ElementType, TypeOfCriticalSectionToUse >::getLock ( ) const
noexcept

The documentation for this class was generated from the following file: