openshot-audio  0.1.4
Public Types | Public Member Functions | Public Attributes | List of all members
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize > Class Template Reference

#include <juce_core.h>

Public Types

typedef TypeOfCriticalSectionToUse::ScopedLockType ScopedLockType
 

Public Member Functions

 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 ()
 
Arrayoperator= (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 ()
 

Public Attributes

JUCE_DEPRECATED_WITH_BODY(void swapWithArray(Array &other) noexcept, { swapWith(other);}) private int numUsed
 

Detailed Description

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
class juce::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:

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

Member Typedef Documentation

◆ ScopedLockType

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
typedef TypeOfCriticalSectionToUse::ScopedLockType juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::ScopedLockType

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

Constructor & Destructor Documentation

◆ Array() [1/4]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array ( )
inlinenoexcept

Creates an empty array.

◆ Array() [2/4]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array ( const Array< ElementType, TypeOfCriticalSectionToUse > &  other)
inline

Creates a copy of another array.

Parameters
otherthe array to copy

◆ Array() [3/4]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename TypeToCreateFrom >
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array ( const TypeToCreateFrom *  values)
inlineexplicit

Initalises from a null-terminated C array of values.

Parameters
valuesthe array to copy from

◆ Array() [4/4]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename TypeToCreateFrom >
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::Array ( const TypeToCreateFrom *  values,
int  numValues 
)
inline

Initalises from a C array of values.

Parameters
valuesthe array to copy from
numValuesthe number of values in the array

◆ ~Array()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::~Array ( )
inline

Destructor.

Member Function Documentation

◆ add()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add ( const ElementType &  newElement)
inline

Appends a new element at the end of the array.

Parameters
newElementthe new object to add to the array
See also
set, insert, addIfNotAlreadyThere, addSorted, addUsingDefaultSort, addArray

◆ addArray() [1/2]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename Type >
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addArray ( const Type *  elementsToAdd,
int  numElementsToAdd 
)
inline

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

Parameters
elementsToAddan array of some kind of object from which elements can be constructed.
numElementsToAddhow many elements are in this other array
See also
add

◆ addArray() [2/2]

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addArray ( const OtherArrayType &  arrayToAddFrom,
int  startIndex = 0,
int  numElementsToAdd = -1 
)
inline

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

◆ addIfNotAlreadyThere()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addIfNotAlreadyThere ( ParameterType  newElement)
inline

Appends a new element at the end of the array as long as the array doesn't already contain it.

If the array already contains an element that matches the one passed in, nothing will be done.

Parameters
newElementthe new object to add to the array

◆ addNullTerminatedArray()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename Type >
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addNullTerminatedArray ( const Type *const *  elementsToAdd)
inline

Adds elements from a null-terminated array of pointers to the end of this array.

Parameters
elementsToAddan array of pointers to some kind of object from which elements can be constructed. This array must be terminated by a nullptr
See also
addArray

◆ addSorted()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class ElementComparator >
int juce::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
comparatorthe comparator to use to compare the elements - see the sort() method for details about the form this object should take
newElementthe new element to insert to the array
Returns
the index at which the new item was added
See also
addUsingDefaultSort, add, sort

◆ addUsingDefaultSort()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
newElementthe new element to insert to the array
See also
addSorted, sort

◆ begin()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType* juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::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<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clear ( )
inline

Removes all elements from the array. This will remove all the elements, and free any storage that the array is using. To clear the array without freeing the storage, use the clearQuick() method instead.

See also
clearQuick

◆ clearQuick()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clearQuick ( )
inline

Removes all elements from the array without freeing the array's allocated storage.

See also
clear

◆ contains()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
bool juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::contains ( ParameterType  elementToLookFor) const
inline

Returns true if the array contains at least one occurrence of an object.

Parameters
elementToLookForthe value or object to look for
Returns
true if the item is found

◆ deleteAllElements()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::deleteAllElements ( )
inlinenoexcept

◆ end()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType* juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::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<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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.

◆ getFirst()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getFirst ( ) const
inline

Returns the first element in the array, or a default value if the array is empty.

See also
operator[], getUnchecked, getLast

◆ getLast()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLast ( ) const
inline

Returns the last element in the array, or a default value if the array is empty.

See also
operator[], getUnchecked, getFirst

◆ getLock()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
const TypeOfCriticalSectionToUse& juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLock ( ) const
inlinenoexcept

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.

◆ getRawDataPointer()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType* juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::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.

◆ getReference()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType& juce::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
indexthe index of the element being requested (0 is the first element in the array)
See also
operator[], getFirst, getLast

◆ getUnchecked()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType juce::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
indexthe index of the element being requested (0 is the first element in the array)
See also
operator[], getFirst, getLast

◆ indexOf()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
int juce::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
elementToLookForthe value or object to look for
Returns
the index of the object, or -1 if it's not found

◆ indexOfSorted()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<typename ElementComparator , typename TargetValueType >
int juce::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
comparatorthe comparator to use to compare the elements - see the sort() method for details about the form this object should take
elementToLookForthe element to search for
Returns
the index of the element, or -1 if it's not found
See also
addSorted, sort

◆ insert()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
indexToInsertAtthe index at which the new element should be inserted (pass in -1 to add it to the end)
newElementthe new object to add to the array
See also
add, addSorted, addUsingDefaultSort, set

◆ insertArray()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
indexToInsertAtthe index at which the first new element should be inserted
newElementsthe new values to add to the array
numberOfElementshow many items are in the array
See also
insert, add, addSorted, set

◆ insertMultiple()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
indexToInsertAtthe index at which the new element should be inserted
newElementthe new object to add to the array
numberOfTimesToInsertIthow many copies of the value to insert
See also
insert, add, addSorted, set

◆ minimiseStorageAfterRemoval()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::minimiseStorageAfterRemoval ( )
inline

◆ minimiseStorageOverheads()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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.

◆ move()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
currentIndexthe index of the value to be moved. If this isn't a valid index, then nothing will be done
newIndexthe 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

◆ operator!=()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
bool juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator!= ( const OtherArrayType &  other) const
inline

Compares this array to another one. Two arrays are considered equal if they both contain the same set of elements, in the same order.

Parameters
otherthe other array to compare with

◆ operator=()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
Array& juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator= ( const Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize > &  other)
inline

Copies another array.

Parameters
otherthe array to copy

◆ operator==()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
bool juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::operator== ( const OtherArrayType &  other) const
inline

Compares this array to another one. Two arrays are considered equal if they both contain the same set of elements, in the same order.

Parameters
otherthe other array to compare with

◆ operator[]()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType juce::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
indexthe index of the element being requested (0 is the first element in the array)
See also
getUnchecked, getFirst, getLast

◆ remove()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
ElementType juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::remove ( const int  indexToRemove)
inline

Removes an element from the array.

This will remove the element at a given index, and move back all the subsequent elements to close the gap. If the index passed in is out-of-range, nothing will happen.

Parameters
indexToRemovethe index of the element to remove
Returns
the element that has been removed
See also
removeFirstMatchingValue, removeAllInstancesOf, removeRange

◆ removeAllInstancesOf()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeAllInstancesOf ( ParameterType  valueToRemove)
inline

Removes an item from the array.

This will remove all occurrences of the given element from the array. If no such items are found, no action is taken.

Parameters
valueToRemovethe object to try to remove
See also
remove, removeRange

◆ removeFirstMatchingValue()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeFirstMatchingValue ( ParameterType  valueToRemove)
inline

Removes an item from the array.

This will remove the first occurrence of the given element from the array. If the item isn't found, no action is taken.

Parameters
valueToRemovethe object to try to remove
See also
remove, removeRange

◆ removeInternal()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeInternal ( const int  indexToRemove)
inline

◆ removeLast()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeLast ( int  howManyToRemove = 1)
inline

Removes the last n elements from the array.

Parameters
howManyToRemovehow many elements to remove from the end of the array
See also
remove, removeFirstMatchingValue, removeAllInstancesOf, removeRange

◆ removeRange()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
startIndexthe index of the first element to remove
numberToRemovehow many elements should be removed
See also
remove, removeFirstMatchingValue, removeAllInstancesOf

◆ removeValuesIn()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeValuesIn ( const OtherArrayType &  otherArray)
inline

Removes any elements which are also in another array.

Parameters
otherArraythe other array in which to look for elements to remove
See also
removeValuesNotIn, remove, removeFirstMatchingValue, removeAllInstancesOf, removeRange

◆ removeValuesNotIn()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeValuesNotIn ( const OtherArrayType &  otherArray)
inline

Removes any elements which are not found in another array.

Only elements which occur in this other array will be retained.

Parameters
otherArraythe array in which to look for elements NOT to remove
See also
removeValuesIn, remove, removeFirstMatchingValue, removeAllInstancesOf, removeRange

◆ resize()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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.

◆ set()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::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
indexToChangethe index whose value you want to change
newValuethe new value to set for this index.
See also
add, insert

◆ setUnchecked()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::setUnchecked ( const int  indexToChange,
ParameterType  newValue 
)
inline

Replaces an element with a new value without doing any bounds-checking.

This just sets a value directly in the array's internal storage, so you'd better make sure it's in range!

Parameters
indexToChangethe index whose value you want to change
newValuethe new value to set for this index.
See also
set, getUnchecked

◆ size()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
int juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size ( ) const
inlinenoexcept

Returns the current number of elements in the array.

◆ sort()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class ElementComparator >
void juce::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
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
addSorted, indexOfSorted, sortArray

◆ swap()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
void juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::swap ( const int  index1,
const int  index2 
)
inline

Swaps over two elements in the array.

This swaps over the elements found at the two indexes passed in. If either index is out-of-range, this method will do nothing.

Parameters
index1index of one of the elements to swap
index2index of the other element to swap

◆ swapWith()

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
template<class OtherArrayType >
void juce::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.

Member Data Documentation

◆ numUsed

template<typename ElementType, typename TypeOfCriticalSectionToUse = DummyCriticalSection, int minimumAllocatedSize = 0>
JUCE_DEPRECATED_WITH_BODY (void swapWithArray (Array& other) noexcept, { swapWith (other); }) private int juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::numUsed

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