|
JUCE
|
Holds a resizable array of primitive or copy-by-value objects. More...
Public Types | |
| typedef TypeOfCriticalSectionToUse::ScopedLockType | ScopedLockType |
| Returns the type of scoped lock to use for locking this array. More... | |
Public Member Functions | |
| Array () noexcept | |
| Creates an empty array. More... | |
| Array (const Array< ElementType, TypeOfCriticalSectionToUse > &other) | |
| Creates a copy of another array. More... | |
| Array (Array< ElementType, TypeOfCriticalSectionToUse > &&other) noexcept | |
| template<typename TypeToCreateFrom > | |
| Array (const TypeToCreateFrom *values) | |
| Initalises from a null-terminated C array of values. More... | |
| template<typename TypeToCreateFrom > | |
| Array (const TypeToCreateFrom *values, int numValues) | |
| Initalises from a C array of values. More... | |
| template<typename TypeToCreateFrom > | |
| Array (const std::initializer_list< TypeToCreateFrom > &items) | |
| ~Array () | |
| Destructor. More... | |
| Array & | operator= (const Array &other) |
| Copies another array. More... | |
| Array & | operator= (Array &&other) noexcept |
| template<class OtherArrayType > | |
| bool | operator== (const OtherArrayType &other) const |
| Compares this array to another one. More... | |
| template<class OtherArrayType > | |
| bool | operator!= (const OtherArrayType &other) const |
| Compares this array to another one. More... | |
| void | clear () |
| Removes all elements from the array. More... | |
| void | clearQuick () |
| Removes all elements from the array without freeing the array's allocated storage. More... | |
| int | size () const noexcept |
| Returns the current number of elements in the array. More... | |
| bool | isEmpty () const noexcept |
| Returns true if the array is empty, false otherwise. More... | |
| ElementType | operator[] (const int index) const |
| Returns one of the elements in the array. More... | |
| ElementType | getUnchecked (const int index) const |
| Returns one of the elements in the array, without checking the index passed in. More... | |
| ElementType & | getReference (const int index) const noexcept |
| Returns a direct reference to one of the elements in the array, without checking the index passed in. More... | |
| ElementType | getFirst () const |
| Returns the first element in the array, or a default value if the array is empty. More... | |
| ElementType | getLast () const |
| Returns the last element in the array, or a default value if the array is empty. More... | |
| ElementType * | getRawDataPointer () noexcept |
| Returns a pointer to the actual array data. More... | |
| ElementType * | begin () const noexcept |
| Returns a pointer to the first element in the array. More... | |
| ElementType * | end () const noexcept |
| Returns a pointer to the element which follows the last element in the array. More... | |
| int | indexOf (ParameterType elementToLookFor) const |
| Finds the index of the first element which matches the value passed in. More... | |
| bool | contains (ParameterType elementToLookFor) const |
| Returns true if the array contains at least one occurrence of an object. More... | |
| void | add (const ElementType &newElement) |
| Appends a new element at the end of the array. More... | |
| void | add (ElementType &&newElement) |
| Appends a new element at the end of the array. More... | |
| void | insert (int indexToInsertAt, ParameterType newElement) |
| Inserts a new element into the array at a given position. More... | |
| void | insertMultiple (int indexToInsertAt, ParameterType newElement, int numberOfTimesToInsertIt) |
| Inserts multiple copies of an element into the array at a given position. More... | |
| void | insertArray (int indexToInsertAt, const ElementType *newElements, int numberOfElements) |
| Inserts an array of values into this array at a given position. More... | |
| void | addIfNotAlreadyThere (ParameterType newElement) |
| Appends a new element at the end of the array as long as the array doesn't already contain it. More... | |
| void | set (const int indexToChange, ParameterType newValue) |
| Replaces an element with a new value. More... | |
| void | setUnchecked (const int indexToChange, ParameterType newValue) |
| Replaces an element with a new value without doing any bounds-checking. More... | |
| template<typename Type > | |
| void | addArray (const Type *elementsToAdd, int numElementsToAdd) |
| Adds elements from an array to the end of this array. More... | |
| template<typename TypeToCreateFrom > | |
| void | addArray (const std::initializer_list< TypeToCreateFrom > &items) |
| template<typename Type > | |
| void | addNullTerminatedArray (const Type *const *elementsToAdd) |
| Adds elements from a null-terminated array of pointers to the end of this array. More... | |
| template<class OtherArrayType > | |
| void | swapWith (OtherArrayType &otherArray) noexcept |
| This swaps the contents of this array with those of another array. More... | |
| template<class OtherArrayType > | |
| void | addArray (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
| Adds elements from another array to the end of this array. More... | |
| void | resize (const int targetNumItems) |
| This will enlarge or shrink the array to the given number of elements, by adding or removing items from its end. More... | |
| template<class ElementComparator > | |
| int | addSorted (ElementComparator &comparator, ParameterType newElement) |
| Inserts a new element into the array, assuming that the array is sorted. More... | |
| void | addUsingDefaultSort (ParameterType newElement) |
| Inserts a new element into the array, assuming that the array is sorted. More... | |
| template<typename ElementComparator , typename TargetValueType > | |
| int | indexOfSorted (ElementComparator &comparator, TargetValueType elementToLookFor) const |
| Finds the index of an element in the array, assuming that the array is sorted. More... | |
| ElementType | remove (const int indexToRemove) |
| Removes an element from the array. More... | |
| void | remove (const ElementType *elementToRemove) |
| Removes an element from the array. More... | |
| void | removeFirstMatchingValue (ParameterType valueToRemove) |
| Removes an item from the array. More... | |
| void | removeAllInstancesOf (ParameterType valueToRemove) |
| Removes an item from the array. More... | |
| void | removeRange (int startIndex, int numberToRemove) |
| Removes a range of elements from the array. More... | |
| void | removeLast (int howManyToRemove=1) |
| Removes the last n elements from the array. More... | |
| template<class OtherArrayType > | |
| void | removeValuesIn (const OtherArrayType &otherArray) |
| Removes any elements which are also in another array. More... | |
| template<class OtherArrayType > | |
| void | removeValuesNotIn (const OtherArrayType &otherArray) |
| Removes any elements which are not found in another array. More... | |
| void | swap (const int index1, const int index2) |
| Swaps over two elements in the array. More... | |
| void | move (const int currentIndex, int newIndex) noexcept |
| Moves one of the values to a different position. More... | |
| void | minimiseStorageOverheads () |
| Reduces the amount of storage being used by the array. More... | |
| void | ensureStorageAllocated (const int minNumElements) |
| Increases the array's internal storage to hold a minimum number of elements. More... | |
| void | sort () |
| Sorts the array using a default comparison operation. More... | |
| template<class ElementComparator > | |
| void | sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) |
| Sorts the elements in the array. More... | |
| const TypeOfCriticalSectionToUse & | getLock () const noexcept |
| Returns the CriticalSection that locks this array. More... | |
Holds a resizable array of primitive or copy-by-value objects.
Examples of arrays are: Array<int>, Array<Rectangle> or Array<MyClass*>
The Array class can be used to hold simple, non-polymorphic objects as well as primitive types - to do so, the class must fulfil these requirements:
You can of course have an array of pointers to any kind of object, e.g. Array<MyClass*>, but if you do this, the array doesn't take any ownership of the objects - see the OwnedArray class or the ReferenceCountedArray class for more powerful ways of holding lists of objects.
For holding lists of strings, you can use Array<String>, but it's usually better to use the specialised class StringArray, which provides more useful functions.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.
| typedef TypeOfCriticalSectionToUse::ScopedLockType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::ScopedLockType |
Returns the type of scoped lock to use for locking this array.
|
noexcept |
Creates an empty array.
| Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array | ( | const Array< ElementType, TypeOfCriticalSectionToUse > & | other | ) |
Creates a copy of another array.
| other | the array to copy |
|
noexcept |
|
explicit |
Initalises from a null-terminated C array of values.
| values | the array to copy from |
| Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array | ( | const TypeToCreateFrom * | values, |
| int | numValues | ||
| ) |
Initalises from a C array of values.
| values | the array to copy from |
| numValues | the number of values in the array |
| Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array | ( | const std::initializer_list< TypeToCreateFrom > & | items | ) |
| Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::~Array | ( | ) |
Destructor.
| Array& Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator= | ( | const Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize > & | other | ) |
Copies another array.
| other | the array to copy |
|
noexcept |
| bool Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator== | ( | const OtherArrayType & | other | ) | const |
Compares this array to another one.
Two arrays are considered equal if they both contain the same set of elements, in the same order.
| other | the other array to compare with |
Referenced by Array< Button::Listener * >::operator!=().
| bool Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator!= | ( | const OtherArrayType & | other | ) | const |
Compares this array to another one.
Two arrays are considered equal if they both contain the same set of elements, in the same order.
| other | the other array to compare with |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clear | ( | ) |
Removes all elements from the array.
This will remove all the elements, and free any storage that the array is using. To clear the array without freeing the storage, use the clearQuick() method instead.
Referenced by SparseSet< int >::clear(), SortedSet< ColourSetting >::clear(), Array< Button::Listener * >::removeValuesIn(), and Array< Button::Listener * >::removeValuesNotIn().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clearQuick | ( | ) |
Removes all elements from the array without freeing the array's allocated storage.
Referenced by VST3BufferExchange< float >::associateBufferTo(), and SortedSet< ColourSetting >::clearQuick().
|
noexcept |
Returns the current number of elements in the array.
Referenced by SortedSet< ColourSetting >::add(), SparseSet< int >::contains(), SelectedItemSet< SelectableItemType >::deselectAll(), PluginBusUtilities::findMaxNumberOfChannelsForBus(), PluginBusUtilities::findTotalNumChannels(), AudioUnitHelpers::getAUChannelInfo(), PluginBusUtilities::getBusCount(), PluginBusUtilities::getDefaultLayoutForChannelNumAndBus(), StretchableObjectResizer::getNumItems(), SparseSet< int >::getNumRanges(), SelectedItemSet< SelectableItemType >::getNumSelected(), SparseSet< int >::getTotalRange(), SortedSet< ColourSetting >::indexOf(), SparseSet< int >::isEmpty(), Array< Button::Listener * >::isEmpty(), VST3BufferExchange< float >::mapArrangementToBusses(), VST3BufferExchange< float >::mapBufferToBusses(), SparseSet< int >::operator!=(), SelectedItemSet< SelectableItemType >::operator=(), SparseSet< int >::operator[](), SparseSet< int >::removeRange(), SortedSet< ColourSetting >::removeValuesIn(), SortedSet< ColourSetting >::removeValuesNotIn(), SelectedItemSet< SelectableItemType >::selectOnly(), SparseSet< int >::size(), SortedSet< ColourSetting >::size(), and Array< Button::Listener * >::sort().
|
noexcept |
Returns true if the array is empty, false otherwise.
| ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator[] | ( | const int | index | ) | const |
Returns one of the elements in the array.
If the index passed in is beyond the range of valid elements, this will return a default value.
If you're certain that the index will always be a valid element, you can call getUnchecked() instead, which is faster.
| index | the index of the element being requested (0 is the first element in the array) |
| ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getUnchecked | ( | const int | index | ) | const |
Returns one of the elements in the array, 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 array, so should only be used when you're confident that it will always be a valid index.
| index | the index of the element being requested (0 is the first element in the array) |
Referenced by SparseSet< int >::contains(), SparseSet< int >::containsRange(), SparseSet< int >::getRange(), SparseSet< int >::getTotalRange(), SortedSet< ColourSetting >::getUnchecked(), VST3BufferExchange< float >::mapBufferToBusses(), SparseSet< int >::operator!=(), SparseSet< int >::operator[](), SparseSet< int >::overlapsRange(), SparseSet< int >::removeRange(), SelectedItemSet< SelectableItemType >::selectOnly(), and SparseSet< int >::size().
|
noexcept |
Returns a direct reference to one of the elements in the array, 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.
| index | the index of the element being requested (0 is the first element in the array) |
Referenced by SortedSet< ColourSetting >::add(), PluginBusUtilities::findMaxNumberOfChannelsForBus(), PluginBusUtilities::findTotalNumChannels(), PluginBusUtilities::getChannelSet(), PluginBusUtilities::getDefaultLayoutForChannelNumAndBus(), PluginBusUtilities::getNumChannels(), SortedSet< ColourSetting >::getReference(), SortedSet< ColourSetting >::indexOf(), VST3BufferExchange< float >::mapArrangementToBusses(), SelectedItemSet< SelectableItemType >::operator=(), SortedSet< ColourSetting >::removeValuesIn(), and SortedSet< ColourSetting >::removeValuesNotIn().
| ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getFirst | ( | ) | const |
Returns the first element in the array, or a default value if the array is empty.
Referenced by SortedSet< ColourSetting >::getFirst().
| ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLast | ( | ) | const |
Returns the last element in the array, or a default value if the array is empty.
Referenced by SortedSet< ColourSetting >::getLast(), and SparseSet< int >::removeRange().
|
noexcept |
Returns a pointer to the actual array data.
This pointer will only be valid until the next time a non-const method is called on the array.
Referenced by VST3BufferExchange< float >::associateBufferTo().
|
noexcept |
Returns a pointer to the first element in the array.
This method is provided for compatibility with standard C++ iteration mechanisms.
Referenced by SortedSet< ColourSetting >::begin(), SelectedItemSet< SelectableItemType >::begin(), and SelectedItemSet< SelectableItemType >::operator=().
|
noexcept |
Returns a pointer to the element which follows the last element in the array.
This method is provided for compatibility with standard C++ iteration mechanisms.
Referenced by SortedSet< ColourSetting >::end(), SelectedItemSet< SelectableItemType >::end(), and SelectedItemSet< SelectableItemType >::operator=().
| int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::indexOf | ( | ParameterType | elementToLookFor | ) | const |
Finds the index of the first element which matches the value passed in.
This will search the array for the given object, and return the index of its first occurrence. If the object isn't found, the method will return -1.
| elementToLookFor | the value or object to look for |
Referenced by SelectedItemSet< SelectableItemType >::deselect().
| bool Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::contains | ( | ParameterType | elementToLookFor | ) | const |
Returns true if the array contains at least one occurrence of an object.
| elementToLookFor | the value or object to look for |
Referenced by Array< Button::Listener * >::addIfNotAlreadyThere(), and SelectedItemSet< SelectableItemType >::isSelected().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add | ( | const ElementType & | newElement | ) |
Appends a new element at the end of the array.
| newElement | the new object to add to the array |
Referenced by Array< Button::Listener * >::addArray(), Array< Button::Listener * >::addIfNotAlreadyThere(), SelectedItemSet< SelectableItemType >::addToSelection(), Array< Button::Listener * >::Array(), VST3BufferExchange< float >::associateBufferTo(), AudioUnitHelpers::getAUChannelInfo(), VST3BufferExchange< float >::mapArrangementToBusses(), SelectedItemSet< SelectableItemType >::operator=(), and SelectedItemSet< SelectableItemType >::selectOnly().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add | ( | ElementType && | newElement | ) |
Appends a new element at the end of the array.
| newElement | the new object to add to the array |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insert | ( | int | indexToInsertAt, |
| ParameterType | newElement | ||
| ) |
Inserts a new element into the array at a given position.
If the index is less than 0 or greater than the size of the array, the element will be added to the end of the array. Otherwise, it will be inserted into the array, moving all the later elements along to make room.
| indexToInsertAt | the index at which the new element should be inserted (pass in -1 to add it to the end) |
| newElement | the new object to add to the array |
Referenced by SortedSet< ColourSetting >::add(), and Array< Button::Listener * >::addSorted().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insertMultiple | ( | int | indexToInsertAt, |
| ParameterType | newElement, | ||
| int | numberOfTimesToInsertIt | ||
| ) |
Inserts multiple copies of an element into the array at a given position.
If the index is less than 0 or greater than the size of the array, the element will be added to the end of the array. Otherwise, it will be inserted into the array, moving all the later elements along to make room.
| indexToInsertAt | the index at which the new element should be inserted |
| newElement | the new object to add to the array |
| numberOfTimesToInsertIt | how many copies of the value to insert |
Referenced by Array< Button::Listener * >::resize().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insertArray | ( | int | indexToInsertAt, |
| const ElementType * | newElements, | ||
| int | numberOfElements | ||
| ) |
Inserts an array of values into this array at a given position.
If the index is less than 0 or greater than the size of the array, the new elements will be added to the end of the array. Otherwise, they will be inserted into the array, moving all the later elements along to make room.
| indexToInsertAt | the index at which the first new element should be inserted |
| newElements | the new values to add to the array |
| numberOfElements | how many items are in the array |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addIfNotAlreadyThere | ( | ParameterType | newElement | ) |
Appends a new element at the end of the array as long as the array doesn't already contain it.
If the array already contains an element that matches the one passed in, nothing will be done.
| newElement | the new object to add to the array |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::set | ( | const int | indexToChange, |
| ParameterType | newValue | ||
| ) |
Replaces an element with a new value.
If the index is less than zero, this method does nothing. If the index is beyond the end of the array, the item is added to the end of the array.
| indexToChange | the index whose value you want to change |
| newValue | the new value to set for this index. |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::setUnchecked | ( | const int | indexToChange, |
| ParameterType | newValue | ||
| ) |
Replaces an element with a new value without doing any bounds-checking.
This just sets a value directly in the array's internal storage, so you'd better make sure it's in range!
| indexToChange | the index whose value you want to change |
| newValue | the new value to set for this index. |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addArray | ( | const Type * | elementsToAdd, |
| int | numElementsToAdd | ||
| ) |
Adds elements from an array to the end of this array.
| elementsToAdd | an array of some kind of object from which elements can be constructed. |
| numElementsToAdd | how many elements are in this other array |
Referenced by Array< Button::Listener * >::addNullTerminatedArray(), Array< Button::Listener * >::Array(), and LassoComponent< SelectableItemType >::dragLasso().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addArray | ( | const std::initializer_list< TypeToCreateFrom > & | items | ) |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addNullTerminatedArray | ( | const Type *const * | elementsToAdd | ) |
Adds elements from a null-terminated array of pointers to the end of this array.
| elementsToAdd | an array of pointers to some kind of object from which elements can be constructed. This array must be terminated by a nullptr |
|
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.
Referenced by Array< Button::Listener * >::operator=(), and SortedSet< ColourSetting >::swapWith().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addArray | ( | const OtherArrayType & | arrayToAddFrom, |
| int | startIndex = 0, |
||
| int | numElementsToAdd = -1 |
||
| ) |
Adds elements from another array to the end of this array.
| arrayToAddFrom | the array from which to copy the elements |
| startIndex | the first element of the other array to start copying from |
| numElementsToAdd | how many elements to add from the other array. If this value is negative or greater than the number of available elements, all available elements will be copied. |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::resize | ( | const int | targetNumItems | ) |
This will enlarge or shrink the array to the given number of elements, by adding or removing items from its end.
If the array is smaller than the given target size, empty elements will be appended until its size is as specified. If its size is larger than the target, items will be removed from its end to shorten it.
| int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addSorted | ( | ElementComparator & | comparator, |
| ParameterType | newElement | ||
| ) |
Inserts a new element into the array, assuming that the array is sorted.
This will use a comparator to find the position at which the new element should go. If the array isn't sorted, the behaviour of this method will be unpredictable.
| comparator | the comparator to use to compare the elements - see the sort() method for details about the form this object should take |
| newElement | the new element to insert to the array |
Referenced by Array< Button::Listener * >::addUsingDefaultSort().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addUsingDefaultSort | ( | ParameterType | newElement | ) |
Inserts a new element into the array, assuming that the array is sorted.
This will use the DefaultElementComparator class for sorting, so your ElementType must be suitable for use with that class. If the array isn't sorted, the behaviour of this method will be unpredictable.
| newElement | the new element to insert to the array |
Referenced by SparseSet< int >::addRange(), and SparseSet< int >::removeRange().
| int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::indexOfSorted | ( | ElementComparator & | comparator, |
| TargetValueType | elementToLookFor | ||
| ) | const |
Finds the index of an element in the array, assuming that the array is sorted.
This will use a comparator to do a binary-chop to find the index of the given element, if it exists. If the array isn't sorted, the behaviour of this method will be unpredictable.
| comparator | the comparator to use to compare the elements - see the sort() method for details about the form this object should take |
| elementToLookFor | the element to search for |
| ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::remove | ( | const int | indexToRemove | ) |
Removes an element from the array.
This will remove the element at a given index, and move back all the subsequent elements to close the gap. If the index passed in is out-of-range, nothing will happen.
| indexToRemove | the index of the element to remove |
Referenced by SelectedItemSet< SelectableItemType >::deselect(), SelectedItemSet< SelectableItemType >::deselectAll(), SelectedItemSet< SelectableItemType >::operator=(), SortedSet< ColourSetting >::remove(), SparseSet< int >::removeRange(), and SortedSet< ColourSetting >::removeValue().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::remove | ( | const ElementType * | elementToRemove | ) |
Removes an element from the array.
This will remove the element pointed to by the given iterator, and move back all the subsequent elements to close the gap. If the iterator passed in does not point to an element within the array, behaviour is undefined.
| elementToRemove | a pointer to the element to remove |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeFirstMatchingValue | ( | ParameterType | valueToRemove | ) |
Removes an item from the array.
This will remove the first occurrence of the given element from the array. If the item isn't found, no action is taken.
| valueToRemove | the object to try to remove |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeAllInstancesOf | ( | ParameterType | valueToRemove | ) |
Removes an item from the array.
This will remove all occurrences of the given element from the array. If no such items are found, no action is taken.
| valueToRemove | the object to try to remove |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeRange | ( | int | startIndex, |
| int | numberToRemove | ||
| ) |
Removes a range of elements from the array.
This will remove a set of elements, starting from the given index, and move subsequent elements down to close the gap.
If the range extends beyond the bounds of the array, it will be safely clipped to the size of the array.
| startIndex | the index of the first element to remove |
| numberToRemove | how many elements should be removed |
Referenced by SparseSet< int >::operator!=(), and Array< Button::Listener * >::resize().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeLast | ( | int | howManyToRemove = 1 | ) |
Removes the last n elements from the array.
| howManyToRemove | how many elements to remove from the end of the array |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeValuesIn | ( | const OtherArrayType & | otherArray | ) |
Removes any elements which are also in another array.
| otherArray | the other array in which to look for elements to remove |
Referenced by LassoComponent< SelectableItemType >::dragLasso().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeValuesNotIn | ( | const OtherArrayType & | otherArray | ) |
Removes any elements which are not found in another array.
Only elements which occur in this other array will be retained.
| otherArray | the array in which to look for elements NOT to remove |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::swap | ( | const int | index1, |
| const int | index2 | ||
| ) |
Swaps over two elements in the array.
This swaps over the elements found at the two indexes passed in. If either index is out-of-range, this method will do nothing.
| index1 | index of one of the elements to swap |
| index2 | index of the other element to swap |
|
noexcept |
Moves one of the values to a different position.
This will move the value to a specified index, shuffling along any intervening elements as required.
So for example, if you have the array { 0, 1, 2, 3, 4, 5 } then calling move (2, 4) would result in { 0, 1, 3, 4, 2, 5 }.
| currentIndex | the index of the value to be moved. If this isn't a valid index, then nothing will be done |
| newIndex | the index at which you'd like this value to end up. If this is less than zero, the value will be moved to the end of the array |
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::minimiseStorageOverheads | ( | ) |
Reduces the amount of storage being used by the array.
Arrays 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.
Referenced by SortedSet< ColourSetting >::minimiseStorageOverheads().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::ensureStorageAllocated | ( | const int | minNumElements | ) |
Increases the array's internal storage to hold a minimum number of elements.
Calling this before adding a large known number of elements means that the array won't have to keep dynamically resizing itself as the elements are added, and it'll therefore be more efficient.
Referenced by SortedSet< ColourSetting >::ensureStorageAllocated().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::sort | ( | ) |
Sorts the array using a default comparison operation.
If the type of your elements isn't supported by the DefaultElementComparator class then you may need to use the other version of sort, which takes a custom comparator.
Referenced by Array< Button::Listener * >::sort().
| void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::sort | ( | ElementComparator & | comparator, |
| const bool | retainOrderOfEquivalentItems = false |
||
| ) |
Sorts the elements in the array.
This will use a comparator object to sort the elements into order. The object passed must have a method of the form:
..and this method must return:
To improve performance, the compareElements() method can be declared as static or const.
| comparator | the comparator to use for comparing elements. |
| retainOrderOfEquivalentItems | if this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged. |
|
noexcept |
Returns the CriticalSection that locks this array.
To lock, you can call getLock().enter() and getLock().exit(), or preferably use an object of ScopedLockType as an RAII lock for it.
Referenced by Array< Button::Listener * >::add(), Array< Button::Listener * >::addArray(), Array< Button::Listener * >::addIfNotAlreadyThere(), Array< Button::Listener * >::addSorted(), Array< Button::Listener * >::Array(), Array< Button::Listener * >::clear(), Array< Button::Listener * >::clearQuick(), Array< Button::Listener * >::contains(), Array< Button::Listener * >::ensureStorageAllocated(), Array< Button::Listener * >::getFirst(), Array< Button::Listener * >::getLast(), SortedSet< ColourSetting >::getLock(), Array< Button::Listener * >::getReference(), Array< Button::Listener * >::getUnchecked(), SortedSet< ColourSetting >::indexOf(), Array< Button::Listener * >::indexOf(), Array< Button::Listener * >::indexOfSorted(), Array< Button::Listener * >::insert(), Array< Button::Listener * >::insertArray(), Array< Button::Listener * >::insertMultiple(), Array< Button::Listener * >::minimiseStorageOverheads(), Array< Button::Listener * >::move(), Array< Button::Listener * >::operator=(), Array< Button::Listener * >::operator==(), Array< Button::Listener * >::operator[](), Array< Button::Listener * >::remove(), Array< Button::Listener * >::removeAllInstancesOf(), Array< Button::Listener * >::removeFirstMatchingValue(), Array< Button::Listener * >::removeLast(), Array< Button::Listener * >::removeRange(), Array< Button::Listener * >::removeValuesIn(), Array< Button::Listener * >::removeValuesNotIn(), Array< Button::Listener * >::set(), Array< Button::Listener * >::setUnchecked(), Array< Button::Listener * >::sort(), Array< Button::Listener * >::swap(), and Array< Button::Listener * >::swapWith().
