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

Holds a list of objects derived from ReferenceCountedObject, or which implement basic reference-count handling methods. More...

Public Types

typedef
ReferenceCountedObjectPtr
< ObjectClass > 
ObjectClassPtr
 
typedef
TypeOfCriticalSectionToUse::ScopedLockType 
ScopedLockType
 Returns the type of scoped lock to use for locking this array.
 

Public Member Functions

 ReferenceCountedArray () noexcept
 Creates an empty array.
 
 ReferenceCountedArray (const ReferenceCountedArray &other) noexcept
 Creates a copy of another array.
 
template<class OtherObjectClass , class OtherCriticalSection >
 ReferenceCountedArray (const ReferenceCountedArray< OtherObjectClass, OtherCriticalSection > &other) noexcept
 Creates a copy of another array.
 
ReferenceCountedArrayoperator= (const ReferenceCountedArray &other) noexcept
 Copies another array into this one.
 
template<class OtherObjectClass >
ReferenceCountedArray
< ObjectClass,
TypeOfCriticalSectionToUse > & 
operator= (const ReferenceCountedArray< OtherObjectClass, TypeOfCriticalSectionToUse > &other) noexcept
 Copies another array into this one.
 
 ~ReferenceCountedArray ()
 Destructor.
 
void clear ()
 Removes all objects from the array.
 
int size () const noexcept
 Returns the current number of objects in the array.
 
ObjectClassPtr operator[] (const int index) const noexcept
 Returns a pointer to the object at this index in the array.
 
ObjectClassPtr getUnchecked (const int index) const noexcept
 Returns a pointer to the object at this index in the array, without checking whether the index is in-range.
 
ObjectClass * getObjectPointer (const int index) const noexcept
 Returns a raw pointer to the object at this index in the array.
 
ObjectClass * getObjectPointerUnchecked (const int index) const noexcept
 Returns a raw pointer to the object at this index in the array, without checking whether the index is in-range.
 
ObjectClassPtr getFirst () const noexcept
 Returns a pointer to the first object in the array.
 
ObjectClassPtr getLast () const noexcept
 Returns a pointer to the last object in the array.
 
ObjectClass ** getRawDataPointer () const noexcept
 Returns a pointer to the actual array data.
 
ObjectClass ** begin () const noexcept
 Returns a pointer to the first element in the array.
 
ObjectClass ** end () const noexcept
 Returns a pointer to the element which follows the last element in the array.
 
int indexOf (const ObjectClass *const objectToLookFor) const noexcept
 Finds the index of the first occurrence of an object in the array.
 
bool contains (const ObjectClass *const objectToLookFor) const noexcept
 Returns true if the array contains a specified object.
 
ObjectClass * add (ObjectClass *const newObject) noexcept
 Appends a new object to the end of the array.
 
ObjectClass * insert (int indexToInsertAt, ObjectClass *const newObject) noexcept
 Inserts a new object into the array at the given index.
 
void addIfNotAlreadyThere (ObjectClass *const newObject) noexcept
 Appends a new object at the end of the array as long as the array doesn't already contain it.
 
void set (const int indexToChange, ObjectClass *const newObject)
 Replaces an object in the array with a different one.
 
void addArray (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) noexcept
 Adds elements from another array to the end of this array.
 
template<class ElementComparator >
int addSorted (ElementComparator &comparator, ObjectClass *newObject) noexcept
 Inserts a new object into the array assuming that the array is sorted.
 
template<class ElementComparator >
void addOrReplaceSorted (ElementComparator &comparator, ObjectClass *newObject) noexcept
 Inserts or replaces an object in the array, assuming it is sorted.
 
template<class ElementComparator >
int indexOfSorted (ElementComparator &comparator, const ObjectClass *const objectToLookFor) const noexcept
 Finds the index of an object in the array, assuming that the array is sorted.
 
void remove (const int indexToRemove)
 Removes an object from the array.
 
ObjectClassPtr removeAndReturn (const int indexToRemove)
 Removes and returns an object from the array.
 
void removeObject (ObjectClass *const objectToRemove)
 Removes the first occurrence of a specified object from the array.
 
void removeRange (const int startIndex, const int numberToRemove)
 Removes a range of objects from the array.
 
void removeLast (int howManyToRemove=1)
 Removes the last n objects from the array.
 
void swap (const int index1, const int index2) noexcept
 Swaps a pair of objects in the array.
 
void move (const int currentIndex, int newIndex) noexcept
 Moves one of the objects to a different position.
 
template<class OtherArrayType >
void swapWith (OtherArrayType &otherArray) noexcept
 This swaps the contents of this array with those of another array.
 
bool operator== (const ReferenceCountedArray &other) const noexcept
 Compares this array to another one.
 
bool operator!= (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &other) const noexcept
 Compares this array to another one.
 
template<class ElementComparator >
void sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const noexcept
 Sorts the elements in the array.
 
void minimiseStorageOverheads () noexcept
 Reduces the amount of storage being used by the array.
 
void ensureStorageAllocated (const int minNumElements)
 Increases the array'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 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

Member Typedef Documentation

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
typedef ReferenceCountedObjectPtr<ObjectClass> ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ObjectClassPtr
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
typedef TypeOfCriticalSectionToUse::ScopedLockType ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ScopedLockType

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

Constructor & Destructor Documentation

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ReferenceCountedArray ( )
noexcept

Creates an empty array.

See Also
ReferenceCountedObject, Array, OwnedArray
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ReferenceCountedArray ( const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &  other)
noexcept

Creates a copy of another array.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherObjectClass , class OtherCriticalSection >
ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ReferenceCountedArray ( const ReferenceCountedArray< OtherObjectClass, OtherCriticalSection > &  other)
noexcept

Creates a copy of another array.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::~ReferenceCountedArray ( )

Destructor.

Any objects in the array will be released, and may be deleted if not referenced from elsewhere.

Member Function Documentation

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

Copies another array into this one.

Any existing objects in this array will first be released.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherObjectClass >
ReferenceCountedArray<ObjectClass, TypeOfCriticalSectionToUse>& ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator= ( const ReferenceCountedArray< OtherObjectClass, TypeOfCriticalSectionToUse > &  other)
noexcept

Copies another array into this one.

Any existing objects in this array will first be released.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear ( )

Removes all objects from the array.

Any objects in the array that are not referenced from elsewhere will be deleted.

Referenced by ReferenceCountedArray< SynthesiserSound >::~ReferenceCountedArray().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::size ( ) const
noexcept

Returns the current number of objects in the array.

Referenced by ReferenceCountedArray< SynthesiserSound >::addArray(), and ReferenceCountedArray< SynthesiserSound >::sort().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClassPtr ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator[] ( const int  index) const
noexcept

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>
ObjectClassPtr ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getUnchecked ( const int  index) const
noexcept

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.

Referenced by ReferenceCountedArray< SynthesiserSound >::addArray().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getObjectPointer ( const int  index) const
noexcept

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

Referenced by ReferenceCountedArray< SynthesiserSound >::operator[]().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getObjectPointerUnchecked ( const int  index) const
noexcept

Returns a raw pointer to the object at this index in the array, without checking whether the index is in-range.

Referenced by ReferenceCountedArray< SynthesiserSound >::getUnchecked().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClassPtr ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getFirst ( ) const
noexcept

Returns a pointer to the first object in the array.

This will return a null pointer if the array's empty.

See Also
getLast
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClassPtr ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLast ( ) const
noexcept

Returns a pointer to the last object in the array.

This will return a null pointer if the array's empty.

See Also
getFirst
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass** ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getRawDataPointer ( ) const
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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass** ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::begin ( ) const
noexcept

Returns a pointer to the first element in the array.

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

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass** ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::end ( ) const
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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf ( const ObjectClass *const  objectToLookFor) const
noexcept

Finds the index of the first occurrence of an object in the array.

Parameters
objectToLookForthe object to look for
Returns
the index at which the object was found, or -1 if it's not found

Referenced by ReferenceCountedArray< SynthesiserSound >::removeObject().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains ( const ObjectClass *const  objectToLookFor) const
noexcept

Returns true if the array contains a specified object.

Parameters
objectToLookForthe object to look for
Returns
true if the object is in the array

Referenced by ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::add ( ObjectClass *const  newObject)
noexcept

Appends a new object to the end of the array.

This will increase the new object's reference count.

Parameters
newObjectthe new object to add to the array
See Also
set, insert, addIfNotAlreadyThere, addSorted, addArray

Referenced by ReferenceCountedArray< SynthesiserSound >::addArray(), ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere(), and ReferenceCountedArray< SynthesiserSound >::insert().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert ( int  indexToInsertAt,
ObjectClass *const  newObject 
)
noexcept

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
indexToInsertAtthe index at which the new element should be inserted
newObjectthe new object to add to the array
See Also
add, addSorted, addIfNotAlreadyThere, set

Referenced by ReferenceCountedArray< SynthesiserSound >::addOrReplaceSorted(), and ReferenceCountedArray< SynthesiserSound >::addSorted().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere ( ObjectClass *const  newObject)
noexcept

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
newObjectthe new object to add to the array
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::set ( const int  indexToChange,
ObjectClass *const  newObject 
)

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
indexToChangethe index whose value you want to change
newObjectthe new value to set for this index.
See Also
add, insert, remove
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addArray ( const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &  arrayToAddFrom,
int  startIndex = 0,
int  numElementsToAdd = -1 
)
noexcept

Adds elements from another array to the end of this array.

Parameters
arrayToAddFromthe array from which to copy the elements
startIndexthe first element of the other array to start copying from
numElementsToAddhow 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>
template<class ElementComparator >
int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted ( ElementComparator &  comparator,
ObjectClass *  newObject 
)
noexcept

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
comparatorthe comparator object to use to compare the elements - see the sort() method for details about this object's form
newObjectthe 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>
template<class ElementComparator >
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted ( ElementComparator &  comparator,
ObjectClass *  newObject 
)
noexcept

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 >::indexOfSorted ( ElementComparator &  comparator,
const ObjectClass *const  objectToLookFor 
) const
noexcept

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
comparatorthe comparator to use to compare the elements - see the sort() method for details about the form this object should take
objectToLookForthe 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>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove ( const int  indexToRemove)

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
indexToRemovethe index of the element to remove
See Also
removeObject, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClassPtr ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeAndReturn ( const int  indexToRemove)

Removes and returns an object from the array.

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 and a null pointer will be returned.

Parameters
indexToRemovethe index of the element to remove
See Also
remove, removeObject, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject ( ObjectClass *const  objectToRemove)

Removes the first occurrence of a specified object from the array.

If the item isn't found, no action is taken. If it is found, it is removed and has its reference count decreased.

Parameters
objectToRemovethe object to try to remove
See Also
remove, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange ( const int  startIndex,
const int  numberToRemove 
)

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
startIndexthe index of the first object to remove
numberToRemovehow many objects should be removed
See Also
remove, removeObject
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast ( int  howManyToRemove = 1)

Removes the last n objects from the array.

The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.

Parameters
howManyToRemovehow many objects to remove from the end of the array
See Also
remove, removeObject, removeRange
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swap ( const int  index1,
const int  index2 
)
noexcept

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>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::move ( const int  currentIndex,
int  newIndex 
)
noexcept

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
currentIndexthe index of the object to be moved. If this isn't a valid index, then nothing will be done
newIndexthe 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>
template<class OtherArrayType >
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swapWith ( OtherArrayType &  otherArray)
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 ReferenceCountedArray< SynthesiserSound >::operator=().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator== ( const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &  other) const
noexcept

Compares this array to another one.

Returns
true only if the other array contains the same objects in the same order

Referenced by ReferenceCountedArray< SynthesiserSound >::operator!=().

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

Compares this array to another one.

See Also
operator==
template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator >
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort ( ElementComparator &  comparator,
const bool  retainOrderOfEquivalentItems = false 
) const
noexcept

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
comparatorthe comparator to use for comparing elements.
retainOrderOfEquivalentItemsif 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>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::minimiseStorageOverheads ( )
noexcept

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 ReferenceCountedArray< SynthesiserSound >::remove(), ReferenceCountedArray< SynthesiserSound >::removeAndReturn(), and ReferenceCountedArray< SynthesiserSound >::removeRange().

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
const TypeOfCriticalSectionToUse& ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLock ( ) const
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 ReferenceCountedArray< SynthesiserSound >::add(), ReferenceCountedArray< SynthesiserSound >::addArray(), ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere(), ReferenceCountedArray< SynthesiserSound >::addOrReplaceSorted(), ReferenceCountedArray< SynthesiserSound >::addSorted(), ReferenceCountedArray< SynthesiserSound >::clear(), ReferenceCountedArray< SynthesiserSound >::contains(), ReferenceCountedArray< SynthesiserSound >::ensureStorageAllocated(), ReferenceCountedArray< SynthesiserSound >::getFirst(), ReferenceCountedArray< SynthesiserSound >::getLast(), ReferenceCountedArray< SynthesiserSound >::getObjectPointer(), ReferenceCountedArray< SynthesiserSound >::getObjectPointerUnchecked(), ReferenceCountedArray< SynthesiserSound >::indexOf(), ReferenceCountedArray< SynthesiserSound >::indexOfSorted(), ReferenceCountedArray< SynthesiserSound >::insert(), ReferenceCountedArray< SynthesiserSound >::minimiseStorageOverheads(), ReferenceCountedArray< SynthesiserSound >::move(), ReferenceCountedArray< SynthesiserSound >::operator==(), ReferenceCountedArray< SynthesiserSound >::remove(), ReferenceCountedArray< SynthesiserSound >::removeAndReturn(), ReferenceCountedArray< SynthesiserSound >::removeLast(), ReferenceCountedArray< SynthesiserSound >::removeObject(), ReferenceCountedArray< SynthesiserSound >::removeRange(), ReferenceCountedArray< SynthesiserSound >::set(), ReferenceCountedArray< SynthesiserSound >::sort(), ReferenceCountedArray< SynthesiserSound >::swap(), and ReferenceCountedArray< SynthesiserSound >::swapWith().


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