A basic object container. More...

Inherits TypeOfCriticalSectionToUse.

Public Member Functions
	ArrayBase () noexcept=default

	~ArrayBase ()

	ArrayBase (ArrayBase &&other) noexcept

ArrayBase &	operator= (ArrayBase &&other) noexcept

template<class OtherElementType , class OtherCriticalSection , typename = AllowConversion<OtherElementType, OtherCriticalSection>>
	ArrayBase (ArrayBase< OtherElementType, OtherCriticalSection > &&other) noexcept
	Converting move constructor.

template<class OtherElementType , class OtherCriticalSection , typename = AllowConversion<OtherElementType, OtherCriticalSection>>
ArrayBase &	operator= (ArrayBase< OtherElementType, OtherCriticalSection > &&other) noexcept
	Converting move assignment operator.

template<class OtherArrayType >
bool	operator== (const OtherArrayType &other) const noexcept

template<class OtherArrayType >
bool	operator!= (const OtherArrayType &other) const noexcept

ElementType &	operator[] (const int index) noexcept

const ElementType &	operator[] (const int index) const noexcept

ElementType	getValueWithDefault (const int index) const noexcept

ElementType	getFirst () const noexcept

ElementType	getLast () const noexcept

ElementType *	begin () noexcept

const ElementType *	begin () const noexcept

ElementType *	end () noexcept

const ElementType *	end () const noexcept

ElementType *	data () noexcept

const ElementType *	data () const noexcept

int	size () const noexcept

int	capacity () const noexcept

void	setAllocatedSize (int numElements)

void	ensureAllocatedSize (int minNumElements)

void	shrinkToNoMoreThan (int maxNumElements)

void	clear ()

void	swapWith (ArrayBase &other) noexcept

void	add (const ElementType &newElement)

void	add (ElementType &&newElement)

template<typename... OtherElements>
void	add (const ElementType &firstNewElement, OtherElements &&... otherElements)

template<typename... OtherElements>
void	add (ElementType &&firstNewElement, OtherElements &&... otherElements)

template<typename Type >
void	addArray (const Type *elementsToAdd, int numElementsToAdd)

template<typename TypeToCreateFrom >
void	addArray (const std::initializer_list< TypeToCreateFrom > &items)

template<class OtherArrayType >
void	addArray (const OtherArrayType &arrayToAddFrom)

template<class OtherArrayType >
std::enable_if_t<! std::is_pointer_v< OtherArrayType >, int >	addArray (const OtherArrayType &arrayToAddFrom, int startIndex, int numElementsToAdd=-1)

void	insert (int indexToInsertAt, ParameterType newElement, int numberOfTimesToInsertIt)

void	insertArray (int indexToInsertAt, const ElementType *newElements, int numberOfElements)

void	removeElements (int indexToRemoveAt, int numElementsToRemove)

void	swap (int index1, int index2)

void	move (int currentIndex, int newIndex) noexcept

Detailed Description

template<class ElementType, class TypeOfCriticalSectionToUse>
class juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >

A basic object container.

This class isn't really for public use - it's used by the other array classes, but might come in handy for some purposes.

It inherits from a critical section class to allow the arrays to use the "empty base class optimisation" pattern to reduce their footprint.

See also: Array, OwnedArray, ReferenceCountedArray

Constructor & Destructor Documentation

◆ ArrayBase() [1/3]

template<class ElementType , class TypeOfCriticalSectionToUse >

juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ArrayBase ( )

defaultnoexcept

◆ ~ArrayBase()

template<class ElementType , class TypeOfCriticalSectionToUse >

juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::~ArrayBase ( )

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::clear().

◆ ArrayBase() [2/3]

template<class ElementType , class TypeOfCriticalSectionToUse >

juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ArrayBase ( ArrayBase< ElementType, TypeOfCriticalSectionToUse > && other )

inlinenoexcept

◆ ArrayBase() [3/3]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherElementType , class OtherCriticalSection , typename = AllowConversion<OtherElementType, OtherCriticalSection>>

juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ArrayBase ( ArrayBase< OtherElementType, OtherCriticalSection > && other )

inlinenoexcept

Converting move constructor.

Only enabled when the other array has a different type to this one. If you see a compile error here, it's probably because you're attempting a conversion that HeapBlock won't allow.

Member Function Documentation

◆ operator=() [1/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

ArrayBase & juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator= ( ArrayBase< ElementType, TypeOfCriticalSectionToUse > && other )

inlinenoexcept

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::swapWith().

◆ operator=() [2/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherElementType , class OtherCriticalSection , typename = AllowConversion<OtherElementType, OtherCriticalSection>>

ArrayBase & juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator= ( ArrayBase< OtherElementType, OtherCriticalSection > && other )

inlinenoexcept

Converting move assignment operator.

Only enabled when the other array has a different type to this one. If you see a compile error here, it's probably because you're attempting a conversion that HeapBlock won't allow.

◆ operator==()

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherArrayType >

bool juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator== ( const OtherArrayType & other ) const

inlinenoexcept

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::begin(), juce::exactlyEqual(), and juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::size().

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator!=().

◆ operator!=()

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherArrayType >

bool juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator!= ( const OtherArrayType & other ) const

inlinenoexcept

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator==().

◆ operator[]() [1/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType & juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator[] ( const int index )

inlinenoexcept

References juce::isPositiveAndBelow(), and jassert.

◆ operator[]() [2/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

const ElementType & juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator[] ( const int index ) const

inlinenoexcept

References juce::isPositiveAndBelow(), and jassert.

◆ getValueWithDefault()

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::getValueWithDefault ( const int index ) const

inlinenoexcept

References juce::isPositiveAndBelow().

◆ getFirst()

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::getFirst ( ) const

inlinenoexcept

◆ getLast()

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::getLast ( ) const

inlinenoexcept

◆ begin() [1/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::begin ( )

inlinenoexcept

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator==().

◆ begin() [2/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

const ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::begin ( ) const

inlinenoexcept

◆ end() [1/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::end ( )

inlinenoexcept

◆ end() [2/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

const ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::end ( ) const

inlinenoexcept

◆ data() [1/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::data ( )

inlinenoexcept

◆ data() [2/2]

template<class ElementType , class TypeOfCriticalSectionToUse >

const ElementType * juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::data ( ) const

inlinenoexcept

◆ size()

template<class ElementType , class TypeOfCriticalSectionToUse >

int juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::size ( ) const

inlinenoexcept

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator==().

◆ capacity()

template<class ElementType , class TypeOfCriticalSectionToUse >

int juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::capacity ( ) const

inlinenoexcept

◆ setAllocatedSize()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::setAllocatedSize ( int numElements )

inline

References jassert.

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize(), and juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::shrinkToNoMoreThan().

◆ ensureAllocatedSize()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize ( int minNumElements )

inline

References jassert, and juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::setAllocatedSize().

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray(), juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray(), and juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray().

◆ shrinkToNoMoreThan()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::shrinkToNoMoreThan ( int maxNumElements )

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::setAllocatedSize().

◆ clear()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::clear ( )

inline

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::~ArrayBase().

◆ swapWith()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::swapWith ( ArrayBase< ElementType, TypeOfCriticalSectionToUse > & other )

inlinenoexcept

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::operator=().

◆ add() [1/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::add ( const ElementType & newElement )

inline

◆ add() [2/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::add ( ElementType && newElement )

inline

◆ add() [3/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<typename... OtherElements>

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::add	(	const ElementType &	firstNewElement,
		OtherElements &&...	otherElements
	)

inline

◆ add() [4/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<typename... OtherElements>

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::add	(	ElementType &&	firstNewElement,
		OtherElements &&...	otherElements
	)

inline

◆ addArray() [1/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<typename Type >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray	(	const Type *	elementsToAdd,
		int	numElementsToAdd
	)

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize().

Referenced by juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray().

◆ addArray() [2/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<typename TypeToCreateFrom >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray ( const std::initializer_list< TypeToCreateFrom > & items )

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize().

◆ addArray() [3/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherArrayType >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray ( const OtherArrayType & arrayToAddFrom )

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize(), and jassert.

◆ addArray() [4/4]

template<class ElementType , class TypeOfCriticalSectionToUse >

template<class OtherArrayType >

std::enable_if_t<! std::is_pointer_v< OtherArrayType >, int > juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray	(	const OtherArrayType &	arrayToAddFrom,
		int	startIndex,
		int	numElementsToAdd = `-1`
	)

inline

References juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::addArray(), jassert, and jassertfalse.

◆ insert()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::insert	(	int	indexToInsertAt,
		ParameterType	newElement,
		int	numberOfTimesToInsertIt
	)

inline

◆ insertArray()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::insertArray	(	int	indexToInsertAt,
		const ElementType *	newElements,
		int	numberOfElements
	)

inline

◆ removeElements()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::removeElements	(	int	indexToRemoveAt,
		int	numElementsToRemove
	)

inline

References jassert.

◆ swap()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::swap	(	int	index1,
		int	index2
	)

inline

References juce::isPositiveAndBelow().

◆ move()

template<class ElementType , class TypeOfCriticalSectionToUse >

void juce::ArrayBase< ElementType, TypeOfCriticalSectionToUse >::move	(	int	currentIndex,
		int	newIndex
	)

inlinenoexcept

References juce::isPositiveAndBelow().

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

juce_core/containers/juce_ArrayBase.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ArrayBase() [1/3]

◆ ~ArrayBase()

◆ ArrayBase() [2/3]

◆ ArrayBase() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator!=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ getValueWithDefault()

◆ getFirst()

◆ getLast()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ size()

◆ capacity()

◆ setAllocatedSize()

◆ ensureAllocatedSize()

◆ shrinkToNoMoreThan()

◆ clear()

◆ swapWith()

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ addArray() [1/4]

◆ addArray() [2/4]

◆ addArray() [3/4]

◆ addArray() [4/4]

◆ insert()

◆ insertArray()

◆ removeElements()

◆ swap()

◆ move()