#include <OwnedArray.h>

Public Member Functions
	OwnedArray () noexcept
	~OwnedArray ()
void	clear (bool deleteObjects=true)
void	clearQuick (bool deleteObjects)
size_t	size () const noexcept
bool	isEmpty () const noexcept
ObjectClass *	operator[] (const size_t 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 (const size_t indexToInsertAt, ObjectClass const newObjects, const size_t numberOfElements)
bool	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, size_t 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 (const size_t indexToRemove, bool deleteObject=true)
ObjectClass *	removeAndReturn (const size_t indexToRemove)
void	removeObject (const ObjectClass *objectToRemove, bool deleteObject=true)
void	removeRange (size_t startIndex, const size_t numberToRemove, bool deleteObjects=true)
void	removeLast (int howManyToRemove=1, bool deleteObjects=true)
void	swap (const size_t index1, const size_t index2) noexcept
void	move (const size_t currentIndex, size_t newIndex) noexcept
template<class OtherArrayType>
void	swapWith (OtherArrayType &otherArray) noexcept
bool	minimiseStorageOverheads () noexcept
bool	ensureStorageAllocated (const int minNumElements) noexcept
template<class ElementComparator>
void	sort (ElementComparator &comparator, bool retainOrderOfEquivalentItems=false) const noexcept

Private Member Functions
void	deleteAllObjects ()

Private Attributes
ArrayAllocationBase< ObjectClass * >	data
size_t	numUsed

Detailed Description

template<class ObjectClass>
class water::OwnedArray< ObjectClass >

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

Constructor & Destructor Documentation

◆ OwnedArray()

template<class ObjectClass>

water::OwnedArray< ObjectClass >::OwnedArray ( )

inlinenoexcept

Creates an empty array.

◆ ~OwnedArray()

template<class ObjectClass>

water::OwnedArray< ObjectClass >::~OwnedArray ( )

inline

Deletes the array and also deletes any objects inside it.

To get rid of the array without deleting its objects, use its clear (false) method before deleting it.

Member Function Documentation

◆ add()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::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

◆ addArray()

template<class ObjectClass>

template<class OtherArrayType>

void water::OwnedArray< ObjectClass >::addArray	(	const OtherArrayType &	arrayToAddFrom,
		int	startIndex = 0,
		int	numElementsToAdd = -1 )

inline

Adds elements from another array to the end of 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

◆ addCopiesOf()

template<class ObjectClass>

template<class OtherArrayType>

void water::OwnedArray< ObjectClass >::addCopiesOf	(	const OtherArrayType &	arrayToAddFrom,
		size_t	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

◆ addIfNotAlreadyThere()

template<class ObjectClass>

bool water::OwnedArray< ObjectClass >::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: true if the new object was added, false otherwise

◆ addSorted()

template<class ObjectClass>

template<class ElementComparator>

int water::OwnedArray< ObjectClass >::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

◆ begin()

template<class ObjectClass>

ObjectClass ** water::OwnedArray< ObjectClass >::begin ( ) const

inlinenoexcept

Returns a pointer to the first element in the array. This method is provided for compatibility with standard C++ iteration mechanisms.

◆ clear()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::clear ( bool deleteObjects = true )

inline

Clears the array, optionally deleting the objects inside it first.

◆ clearQuick()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::clearQuick ( bool deleteObjects )

inline

Clears the array, optionally deleting the objects inside it first.

◆ contains()

template<class ObjectClass>

bool water::OwnedArray< ObjectClass >::contains ( const ObjectClass * objectToLookFor ) const

inlinenoexcept

Returns true if the array contains a specified object.

Parameters

objectToLookFor the object to look for

Returns: true if the object is in the array

◆ deleteAllObjects()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::deleteAllObjects ( )

inlineprivate

◆ end()

template<class ObjectClass>

ObjectClass ** water::OwnedArray< ObjectClass >::end ( ) const

inlinenoexcept

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.

◆ ensureStorageAllocated()

template<class ObjectClass>

bool water::OwnedArray< ObjectClass >::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.

◆ getFirst()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::getFirst ( ) const

inlinenoexcept

Returns a pointer to the first object in the array.

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

See also: getLast

◆ getLast()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::getLast ( ) const

inlinenoexcept

Returns a pointer to the last object in the array.

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

See also: getFirst

◆ getRawDataPointer()

template<class ObjectClass>

ObjectClass ** water::OwnedArray< ObjectClass >::getRawDataPointer ( )

inlinenoexcept

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.

◆ getUnchecked()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::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.

◆ indexOf()

template<class ObjectClass>

int water::OwnedArray< ObjectClass >::indexOf ( const ObjectClass * objectToLookFor ) const

inlinenoexcept

Finds the index of an object which might be in the array.

Parameters

objectToLookFor the object to look for

Returns: the index at which the object was found, or -1 if it's not found

◆ indexOfSorted()

template<class ObjectClass>

template<typename ElementComparator>

int water::OwnedArray< ObjectClass >::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

◆ insert()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::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

◆ insertArray()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::insertArray	(	const size_t	indexToInsertAt,
		ObjectClass const	newObjects,
		const size_t	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

◆ isEmpty()

template<class ObjectClass>

bool water::OwnedArray< ObjectClass >::isEmpty ( ) const

inlinenoexcept

Returns true if the array is empty, false otherwise.

◆ minimiseStorageOverheads()

template<class ObjectClass>

bool water::OwnedArray< ObjectClass >::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.

◆ move()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::move	(	const size_t	currentIndex,
		size_t	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

◆ operator[]()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::operator[] ( const size_t 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

◆ remove()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::remove	(	const size_t	indexToRemove,
		bool	deleteObject = true )

inline

Removes an object from the array.

This will remove the object at a given index (optionally also deleting it) and move 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
deleteObject	whether to delete the object that is removed

See also: removeObject, removeRange

◆ removeAndReturn()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::removeAndReturn ( const size_t 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

◆ removeLast()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::removeLast	(	int	howManyToRemove = 1,
		bool	deleteObjects = true )

inline

Removes the last n objects from the array.

Parameters

howManyToRemove	how many objects to remove from the end of the array
deleteObjects	whether to also delete the objects that are removed

See also: remove, removeObject, removeRange

◆ removeObject()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::removeObject	(	const ObjectClass *	objectToRemove,
		bool	deleteObject = true )

inline

Removes a specified object from the array.

If the item isn't found, no action is taken.

Parameters

objectToRemove	the object to try to remove
deleteObject	whether to delete the object (if it's found)

See also: remove, removeRange

◆ removeRange()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::removeRange	(	size_t	startIndex,
		const size_t	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

◆ set()

template<class ObjectClass>

ObjectClass * water::OwnedArray< ObjectClass >::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

◆ size()

template<class ObjectClass>

size_t water::OwnedArray< ObjectClass >::size ( ) const

inlinenoexcept

Returns the number of items currently in the array.

See also: operator[]

◆ sort()

template<class ObjectClass>

template<class ElementComparator>

void water::OwnedArray< ObjectClass >::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

◆ swap()

template<class ObjectClass>

void water::OwnedArray< ObjectClass >::swap	(	const size_t	index1,
		const size_t	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.

◆ swapWith()

template<class ObjectClass>

template<class OtherArrayType>

void water::OwnedArray< ObjectClass >::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.

Member Data Documentation

◆ data

template<class ObjectClass>

ArrayAllocationBase<ObjectClass*> water::OwnedArray< ObjectClass >::data

private

◆ numUsed

template<class ObjectClass>

size_t water::OwnedArray< ObjectClass >::numUsed

private

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/containers/OwnedArray.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OwnedArray()

◆ ~OwnedArray()

Member Function Documentation

◆ add()

◆ addArray()

◆ addCopiesOf()

◆ addIfNotAlreadyThere()

◆ addSorted()

◆ begin()

◆ clear()

◆ clearQuick()

◆ contains()

◆ deleteAllObjects()

◆ end()

◆ ensureStorageAllocated()

◆ getFirst()

◆ getLast()

◆ getRawDataPointer()

◆ getUnchecked()

◆ indexOf()

◆ indexOfSorted()

◆ insert()

◆ insertArray()

◆ isEmpty()

◆ minimiseStorageOverheads()

◆ move()

◆ operator[]()

◆ remove()

◆ removeAndReturn()

◆ removeLast()

◆ removeObject()

◆ removeRange()

◆ set()

◆ size()

◆ sort()

◆ swap()

◆ swapWith()

Member Data Documentation

◆ data

◆ numUsed