|
| Array () noexcept |
|
| Array (const Array< ElementType, TypeOfCriticalSectionToUse > &other) |
|
template<typename TypeToCreateFrom > |
| Array (const TypeToCreateFrom *values) |
|
template<typename TypeToCreateFrom > |
| Array (const TypeToCreateFrom *values, int numValues) |
|
| ~Array () |
|
Array & | operator= (const Array &other) |
|
template<class OtherArrayType > |
bool | operator== (const OtherArrayType &other) const |
|
template<class OtherArrayType > |
bool | operator!= (const OtherArrayType &other) const |
|
void | clear () |
|
void | clearQuick () |
|
int | size () const noexcept |
|
ElementType | operator[] (const int index) const |
|
ElementType | getUnchecked (const int index) const |
|
ElementType & | getReference (const int index) const noexcept |
|
ElementType | getFirst () const |
|
ElementType | getLast () const |
|
ElementType * | getRawDataPointer () noexcept |
|
ElementType * | begin () const noexcept |
|
ElementType * | end () const noexcept |
|
int | indexOf (ParameterType elementToLookFor) const |
|
bool | contains (ParameterType elementToLookFor) const |
|
void | add (const ElementType &newElement) |
|
void | insert (int indexToInsertAt, ParameterType newElement) |
|
void | insertMultiple (int indexToInsertAt, ParameterType newElement, int numberOfTimesToInsertIt) |
|
void | insertArray (int indexToInsertAt, const ElementType *newElements, int numberOfElements) |
|
void | addIfNotAlreadyThere (ParameterType newElement) |
|
void | set (const int indexToChange, ParameterType newValue) |
|
void | setUnchecked (const int indexToChange, ParameterType newValue) |
|
template<typename Type > |
void | addArray (const Type *elementsToAdd, int numElementsToAdd) |
|
template<typename Type > |
void | addNullTerminatedArray (const Type *const *elementsToAdd) |
|
template<class OtherArrayType > |
void | swapWith (OtherArrayType &otherArray) noexcept |
|
template<class OtherArrayType > |
void | addArray (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
|
void | resize (const int targetNumItems) |
|
template<class ElementComparator > |
int | addSorted (ElementComparator &comparator, ParameterType newElement) |
|
void | addUsingDefaultSort (ParameterType newElement) |
|
template<typename ElementComparator , typename TargetValueType > |
int | indexOfSorted (ElementComparator &comparator, TargetValueType elementToLookFor) const |
|
ElementType | remove (const int indexToRemove) |
|
void | removeFirstMatchingValue (ParameterType valueToRemove) |
|
void | removeAllInstancesOf (ParameterType valueToRemove) |
|
void | removeRange (int startIndex, int numberToRemove) |
|
void | removeLast (int howManyToRemove=1) |
|
template<class OtherArrayType > |
void | removeValuesIn (const OtherArrayType &otherArray) |
|
template<class OtherArrayType > |
void | removeValuesNotIn (const OtherArrayType &otherArray) |
|
void | swap (const int index1, const int index2) |
|
void | move (const int currentIndex, int newIndex) noexcept |
|
void | minimiseStorageOverheads () |
|
void | ensureStorageAllocated (const int minNumElements) |
|
template<class ElementComparator > |
void | sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const |
|
const TypeOfCriticalSectionToUse & | getLock () const noexcept |
|
void | removeInternal (const int indexToRemove) |
|
void | deleteAllElements () noexcept |
|
void | minimiseStorageAfterRemoval () |
|
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
class Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >
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:
- it must have a copy constructor and assignment operator
- it must be able to be relocated in memory by a memcpy without this causing any problems - so objects whose functionality relies on external pointers or references to themselves can not be used.
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.
- See also
- OwnedArray, ReferenceCountedArray, StringArray, CriticalSection
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class ElementComparator >
int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addSorted |
( |
ElementComparator & |
comparator, |
|
|
ParameterType |
newElement |
|
) |
| |
|
inline |
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.
- Parameters
-
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 |
- Returns
- the index at which the new item was added
- See also
- addUsingDefaultSort, add, sort
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addUsingDefaultSort |
( |
ParameterType |
newElement | ) |
|
|
inline |
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.
- Parameters
-
newElement | the new element to insert to the array |
- See also
- addSorted, sort
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::ensureStorageAllocated |
( |
const int |
minNumElements | ) |
|
|
inline |
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.
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType& Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference |
( |
const int |
index | ) |
const |
|
inlinenoexcept |
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.
- Parameters
-
index | the index of the element being requested (0 is the first element in the array) |
- See also
- operator[], getFirst, getLast
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getUnchecked |
( |
const int |
index | ) |
const |
|
inline |
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.
- Parameters
-
index | the index of the element being requested (0 is the first element in the array) |
- See also
- operator[], getFirst, getLast
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::indexOf |
( |
ParameterType |
elementToLookFor | ) |
const |
|
inline |
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.
- Parameters
-
elementToLookFor | the value or object to look for |
- Returns
- the index of the object, or -1 if it's not found
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename ElementComparator , typename TargetValueType >
int Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::indexOfSorted |
( |
ElementComparator & |
comparator, |
|
|
TargetValueType |
elementToLookFor |
|
) |
| const |
|
inline |
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.
- Parameters
-
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 |
- Returns
- the index of the element, or -1 if it's not found
- See also
- addSorted, sort
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insert |
( |
int |
indexToInsertAt, |
|
|
ParameterType |
newElement |
|
) |
| |
|
inline |
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.
- Parameters
-
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 |
- See also
- add, addSorted, addUsingDefaultSort, set
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insertArray |
( |
int |
indexToInsertAt, |
|
|
const ElementType * |
newElements, |
|
|
int |
numberOfElements |
|
) |
| |
|
inline |
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.
- Parameters
-
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 |
- See also
- insert, add, addSorted, set
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::insertMultiple |
( |
int |
indexToInsertAt, |
|
|
ParameterType |
newElement, |
|
|
int |
numberOfTimesToInsertIt |
|
) |
| |
|
inline |
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.
- Parameters
-
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 |
- See also
- insert, add, addSorted, set
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::minimiseStorageOverheads |
( |
| ) |
|
|
inline |
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.
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::move |
( |
const int |
currentIndex, |
|
|
int |
newIndex |
|
) |
| |
|
inlinenoexcept |
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 }.
- Parameters
-
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 |
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator[] |
( |
const int |
index | ) |
const |
|
inline |
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.
- Parameters
-
index | the index of the element being requested (0 is the first element in the array) |
- See also
- getUnchecked, getFirst, getLast
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeRange |
( |
int |
startIndex, |
|
|
int |
numberToRemove |
|
) |
| |
|
inline |
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.
- Parameters
-
startIndex | the index of the first element to remove |
numberToRemove | how many elements should be removed |
- See also
- remove, removeFirstMatchingValue, removeAllInstancesOf
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::resize |
( |
const int |
targetNumItems | ) |
|
|
inline |
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.
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::set |
( |
const int |
indexToChange, |
|
|
ParameterType |
newValue |
|
) |
| |
|
inline |
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.
- Parameters
-
indexToChange | the index whose value you want to change |
newValue | the new value to set for this index. |
- See also
- add, insert
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class ElementComparator >
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::sort |
( |
ElementComparator & |
comparator, |
|
|
const bool |
retainOrderOfEquivalentItems = false |
|
) |
| const |
|
inline |
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:
int compareElements (ElementType first, ElementType second);
..and this method must return:
- a value of < 0 if the first comes before the second
- a value of 0 if the two objects are equivalent
- a value of > 0 if the second comes before the first
To improve performance, the compareElements() method can be declared as static or const.
- Parameters
-
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. |
- See also
- addSorted, indexOfSorted, sortArray
template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
void Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::swapWith |
( |
OtherArrayType & |
otherArray | ) |
|
|
inlinenoexcept |
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.