|
| ReferenceCountedArray () noexcept |
|
| ReferenceCountedArray (const ReferenceCountedArray &other) noexcept |
|
template<class OtherObjectClass , class OtherCriticalSection > |
| ReferenceCountedArray (const ReferenceCountedArray< OtherObjectClass, OtherCriticalSection > &other) noexcept |
|
ReferenceCountedArray & | operator= (const ReferenceCountedArray &other) noexcept |
|
template<class OtherObjectClass > |
ReferenceCountedArray
< ObjectClass,
TypeOfCriticalSectionToUse > & | operator= (const ReferenceCountedArray< OtherObjectClass, TypeOfCriticalSectionToUse > &other) noexcept |
|
| ~ReferenceCountedArray () |
|
void | clear () |
|
void | clearQuick () |
|
int | size () const noexcept |
|
ObjectClassPtr | operator[] (const int index) const noexcept |
|
ObjectClassPtr | getUnchecked (const int index) const noexcept |
|
ObjectClass * | getObjectPointer (const int index) const noexcept |
|
ObjectClass * | getObjectPointerUnchecked (const int index) const noexcept |
|
ObjectClassPtr | getFirst () const noexcept |
|
ObjectClassPtr | getLast () const noexcept |
|
ObjectClass ** | getRawDataPointer () const noexcept |
|
ObjectClass ** | begin () const noexcept |
|
ObjectClass ** | end () const noexcept |
|
int | indexOf (const ObjectClass *const objectToLookFor) const noexcept |
|
bool | contains (const ObjectClass *const objectToLookFor) const noexcept |
|
ObjectClass * | add (ObjectClass *const newObject) noexcept |
|
ObjectClass * | insert (int indexToInsertAt, ObjectClass *const newObject) noexcept |
|
void | addIfNotAlreadyThere (ObjectClass *const newObject) noexcept |
|
void | set (const int indexToChange, ObjectClass *const newObject) |
|
void | addArray (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) noexcept |
|
template<class ElementComparator > |
int | addSorted (ElementComparator &comparator, ObjectClass *newObject) noexcept |
|
template<class ElementComparator > |
void | addOrReplaceSorted (ElementComparator &comparator, ObjectClass *newObject) noexcept |
|
template<class ElementComparator > |
int | indexOfSorted (ElementComparator &comparator, const ObjectClass *const objectToLookFor) const noexcept |
|
void | remove (const int indexToRemove) |
|
ObjectClassPtr | removeAndReturn (const int indexToRemove) |
|
void | removeObject (ObjectClass *const objectToRemove) |
|
void | removeRange (const int startIndex, const int numberToRemove) |
|
void | removeLast (int howManyToRemove=1) |
|
void | swap (const int index1, const int index2) noexcept |
|
void | move (const int currentIndex, int newIndex) noexcept |
|
template<class OtherArrayType > |
void | swapWith (OtherArrayType &otherArray) noexcept |
|
bool | operator== (const ReferenceCountedArray &other) const noexcept |
|
bool | operator!= (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &other) const noexcept |
|
template<class ElementComparator > |
void | sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const noexcept |
|
void | minimiseStorageOverheads () noexcept |
|
void | ensureStorageAllocated (const int minNumElements) |
|
const TypeOfCriticalSectionToUse & | getLock () const noexcept |
|
void | releaseAllObjects () |
|
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
class ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >
Holds a list of objects derived from ReferenceCountedObject, or which implement basic reference-count handling methods.
The template parameter specifies the class of the object you want to point to - the easiest way to make a class reference-countable is to simply make it inherit from ReferenceCountedObject or SingleThreadedReferenceCountedObject, but if you need to, you can roll your own reference-countable class by implementing a set of methods called incReferenceCount(), decReferenceCount(), and decReferenceCountWithoutDeleting(). See ReferenceCountedObject for examples of how these methods should behave.
A ReferenceCountedArray holds objects derived from ReferenceCountedObject, and takes care of incrementing and decrementing their ref counts when they are added and removed from the array.
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, OwnedArray, StringArray
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted |
( |
ElementComparator & |
comparator, |
|
|
ObjectClass * |
newObject |
|
) |
| |
|
inlinenoexcept |
Inserts or replaces an object in the array, assuming it is sorted.
This is similar to addSorted, but if a matching element already exists, then it will be replaced by the new one, rather than the new one being added as well.
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted |
( |
ElementComparator & |
comparator, |
|
|
ObjectClass * |
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 object to use to compare the elements - see the sort() method for details about this object's form |
newObject | the new object to insert to the array |
- Returns
- the index at which the new object was added
- See Also
- add, sort
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
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>
Returns a raw 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>
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<class ElementComparator >
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>
Inserts a new object into the array at the given index.
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.
This will increase the new object's reference count.
- Parameters
-
indexToInsertAt | the index at which the new element should be inserted |
newObject | the new object to add to the array |
- See Also
- add, addSorted, addIfNotAlreadyThere, set
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
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>
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>
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>
Removes an object from the array.
This will remove the object at a given index and move back all the subsequent objects to close the gap.
If the index passed in is out-of-range, nothing will happen.
The object that is removed will have its reference count decreased, and may be deleted if not referenced from elsewhere.
- Parameters
-
indexToRemove | the index of the element to remove |
- See Also
- removeObject, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
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.
The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.
- Parameters
-
startIndex | the index of the first object to remove |
numberToRemove | how many objects should be removed |
- See Also
- remove, removeObject
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
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.
The object being added has its reference count increased, and if it's replacing another object, then that one has its reference count decreased, and may be deleted.
- Parameters
-
indexToChange | the index whose value you want to change |
newObject | the new value to set for this index. |
- See Also
- add, insert, remove
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort |
( |
ElementComparator & |
comparator, |
|
|
const 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
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherArrayType >
void ReferenceCountedArray< 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.