|
| OwnedArray () noexcept |
|
| ~OwnedArray () |
|
void | clear (bool deleteObjects=true) |
|
void | clearQuick (bool deleteObjects) |
|
int | size () const noexcept |
|
ObjectClass * | operator[] (const int index) const noexcept |
|
ObjectClass * | getUnchecked (const int index) const noexcept |
|
ObjectClass * | getFirst () const noexcept |
|
ObjectClass * | getLast () const noexcept |
|
ObjectClass ** | getRawDataPointer () noexcept |
|
ObjectClass ** | begin () const noexcept |
|
ObjectClass ** | end () const noexcept |
|
int | indexOf (const ObjectClass *objectToLookFor) const noexcept |
|
bool | contains (const ObjectClass *objectToLookFor) const noexcept |
|
ObjectClass * | add (ObjectClass *newObject) noexcept |
|
ObjectClass * | insert (int indexToInsertAt, ObjectClass *newObject) noexcept |
|
void | insertArray (int indexToInsertAt, ObjectClass *const *newObjects, int numberOfElements) |
|
ObjectClass * | addIfNotAlreadyThere (ObjectClass *newObject) noexcept |
|
ObjectClass * | set (int indexToChange, ObjectClass *newObject, bool deleteOldElement=true) |
|
template<class OtherArrayType > |
void | addArray (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
|
template<class OtherArrayType > |
void | addCopiesOf (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
|
template<class ElementComparator > |
int | addSorted (ElementComparator &comparator, ObjectClass *const newObject) noexcept |
|
template<typename ElementComparator > |
int | indexOfSorted (ElementComparator &comparator, const ObjectClass *const objectToLookFor) const noexcept |
|
void | remove (int indexToRemove, bool deleteObject=true) |
|
ObjectClass * | removeAndReturn (int indexToRemove) |
|
void | removeObject (const ObjectClass *objectToRemove, bool deleteObject=true) |
|
void | removeRange (int startIndex, int numberToRemove, bool deleteObjects=true) |
|
void | removeLast (int howManyToRemove=1, bool deleteObjects=true) |
|
void | swap (int index1, int index2) noexcept |
|
void | move (int currentIndex, int newIndex) noexcept |
|
template<class OtherArrayType > |
void | swapWith (OtherArrayType &otherArray) noexcept |
|
void | minimiseStorageOverheads () noexcept |
|
void | ensureStorageAllocated (const int minNumElements) noexcept |
|
template<class ElementComparator > |
void | sort (ElementComparator &comparator, bool retainOrderOfEquivalentItems=false) const noexcept |
|
const TypeOfCriticalSectionToUse & | getLock () const noexcept |
|
void | deleteAllObjects () |
|
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
class OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >
An array designed for holding objects.
This holds a list of pointers to objects, and will automatically delete the objects when they are removed from the array, or when the array is itself deleted.
Declare it in the form: OwnedArray<MyObjectClass>
..and then add new objects, e.g. myOwnedArray.add (new MyObjectClass());
After adding objects, they are 'owned' by the array and will be deleted when removed or replaced.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.
- See also
- Array, ReferenceCountedArray, StringArray, CriticalSection
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::add |
( |
ObjectClass * |
newObject | ) |
|
|
inlinenoexcept |
Appends a new object to the end of the array.
Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.
Also be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
- Parameters
-
newObject | the new object to add to the array |
- Returns
- the new object that was added
- See also
- set, insert, addIfNotAlreadyThere, addSorted
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherArrayType >
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addCopiesOf |
( |
const OtherArrayType & |
arrayToAddFrom, |
|
|
int |
startIndex = 0 , |
|
|
int |
numElementsToAdd = -1 |
|
) |
| |
|
inline |
Adds copies of the elements in another array to the end of this array.
The other array must be either an OwnedArray of a compatible type of object, or an Array containing pointers to the same kind of object. The objects involved must provide a copy constructor, and this will be used to create new copies of each element, and add them to this array.
- Parameters
-
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. |
- See also
- add
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere |
( |
ObjectClass * |
newObject | ) |
|
|
inlinenoexcept |
Appends a new object at the end of the array as long as the array doesn't already contain it.
If the array already contains a matching object, nothing will be done.
- Parameters
-
newObject | the new object to add to the array |
- Returns
- the new object that was added
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted |
( |
ElementComparator & |
comparator, |
|
|
ObjectClass *const |
newObject |
|
) |
| |
|
inlinenoexcept |
Inserts a new object into the array assuming that the array is sorted.
This will use a comparator to find the position at which the new object 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 this object's structure |
newObject | the new object to insert to the array |
- Returns
- the index at which the new object was added
- See also
- add, sort, indexOfSorted
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::ensureStorageAllocated |
( |
const int |
minNumElements | ) |
|
|
inlinenoexcept |
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<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getUnchecked |
( |
const int |
index | ) |
const |
|
inlinenoexcept |
Returns a pointer to the object at this index in the array, without checking whether the index is in-range.
This is a faster and less safe version of operator[] which doesn't check the index passed in, so it can be used when you're sure the index is always going to be legal.
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<typename ElementComparator >
int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOfSorted |
( |
ElementComparator & |
comparator, |
|
|
const ObjectClass *const |
objectToLookFor |
|
) |
| const |
|
inlinenoexcept |
Finds the index of an object 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 |
objectToLookFor | the object to search for |
- Returns
- the index of the element, or -1 if it's not found
- See also
- addSorted, sort
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert |
( |
int |
indexToInsertAt, |
|
|
ObjectClass * |
newObject |
|
) |
| |
|
inlinenoexcept |
Inserts a new object into the array at the given index.
Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.
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.
Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
- Parameters
-
indexToInsertAt | the index at which the new element should be inserted |
newObject | the new object to add to the array |
- Returns
- the new object that was added
- See also
- add, addSorted, addIfNotAlreadyThere, set
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::insertArray |
( |
int |
indexToInsertAt, |
|
|
ObjectClass *const * |
newObjects, |
|
|
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 |
newObjects | the new values to add to the array |
numberOfElements | how many items are in the array |
- See also
- insert, add, addSorted, set
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::minimiseStorageOverheads |
( |
| ) |
|
|
inlinenoexcept |
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<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::move |
( |
int |
currentIndex, |
|
|
int |
newIndex |
|
) |
| |
|
inlinenoexcept |
Moves one of the objects to a different position.
This will move the object 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 object to be moved. If this isn't a valid index, then nothing will be done |
newIndex | the index at which you'd like this object to end up. If this is less than zero, it will be moved to the end of the array |
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator[] |
( |
const int |
index | ) |
const |
|
inlinenoexcept |
Returns a pointer to the object at this index in the array.
If the index is out-of-range, this will return a null pointer, (and it could be null anyway, because it's ok for the array to hold null pointers as well as objects).
- See also
- getUnchecked
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeAndReturn |
( |
int |
indexToRemove | ) |
|
|
inline |
Removes and returns an object from the array without deleting it.
This will remove the object at a given index and return it, moving back all the subsequent objects to close the gap. If the index passed in is out-of-range, nothing will happen.
- Parameters
-
indexToRemove | the index of the element to remove |
- See also
- remove, removeObject, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange |
( |
int |
startIndex, |
|
|
int |
numberToRemove, |
|
|
bool |
deleteObjects = true |
|
) |
| |
|
inline |
Removes a range of objects from the array.
This will remove a set of objects, starting from the given index, and move any 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 object to remove |
numberToRemove | how many objects should be removed |
deleteObjects | whether to delete the objects that get removed |
- See also
- remove, removeObject
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::set |
( |
int |
indexToChange, |
|
|
ObjectClass * |
newObject, |
|
|
bool |
deleteOldElement = true |
|
) |
| |
|
inline |
Replaces an object in the array with a different one.
If the index is less than zero, this method does nothing. If the index is beyond the end of the array, the new object is added to the end of the array.
Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
- Parameters
-
indexToChange | the index whose value you want to change |
newObject | the new value to set for this index. |
deleteOldElement | whether to delete the object that's being replaced with the new one |
- See also
- add, insert, remove
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort |
( |
ElementComparator & |
comparator, |
|
|
bool |
retainOrderOfEquivalentItems = false |
|
) |
| const |
|
inlinenoexcept |
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
- sortArray, indexOfSorted
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::swap |
( |
int |
index1, |
|
|
int |
index2 |
|
) |
| |
|
inlinenoexcept |
Swaps a pair of objects in the array.
If either of the indexes passed in is out-of-range, nothing will happen, otherwise the two objects at these positions will be exchanged.
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherArrayType >
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::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.