OpenShot Library | libopenshot-audio 0.2.0
juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse > Class Template Reference

Implements some basic array storage allocation functions. More...

#include <juce_ArrayAllocationBase.h>

+ Inheritance diagram for juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >:

Public Member Functions

 ArrayAllocationBase ()=default
 Creates an empty array.
 
 ~ArrayAllocationBase ()=default
 Destructor.
 
 ArrayAllocationBase (ArrayAllocationBase &&other) noexcept
 
ArrayAllocationBaseoperator= (ArrayAllocationBase &&other) noexcept
 
void setAllocatedSize (int numElements)
 Changes the amount of storage allocated.
 
void ensureAllocatedSize (int minNumElements)
 Increases the amount of storage allocated if it is less than a given amount.
 
void shrinkToNoMoreThan (int maxNumElements)
 Minimises the amount of storage allocated so that it's no more than the given number of elements.
 
void swapWith (ArrayAllocationBase &other) noexcept
 Swap the contents of two objects.
 

Public Attributes

HeapBlock< ElementType > elements
 
int numAllocated = 0
 

Detailed Description

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

Implements some basic array storage allocation functions.

This class isn't really for public use - it used to be part of the container classes but has since been superseded by ArrayBase. Eventually it will be removed from the API.

Definition at line 41 of file juce_ArrayAllocationBase.h.

Constructor & Destructor Documentation

◆ ArrayAllocationBase()

template<class ElementType , class TypeOfCriticalSectionToUse >
juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::ArrayAllocationBase ( ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse > &&  other)
inlinenoexcept

Definition at line 51 of file juce_ArrayAllocationBase.h.

Member Function Documentation

◆ operator=()

template<class ElementType , class TypeOfCriticalSectionToUse >
ArrayAllocationBase & juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::operator= ( ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse > &&  other)
inlinenoexcept

Definition at line 57 of file juce_ArrayAllocationBase.h.

◆ setAllocatedSize()

template<class ElementType , class TypeOfCriticalSectionToUse >
void juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::setAllocatedSize ( int  numElements)
inline

Changes the amount of storage allocated.

This will retain any data currently held in the array, and either add or remove extra space at the end.

Parameters
numElementsthe number of elements that are needed

Definition at line 72 of file juce_ArrayAllocationBase.h.

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

◆ ensureAllocatedSize()

template<class ElementType , class TypeOfCriticalSectionToUse >
void juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::ensureAllocatedSize ( int  minNumElements)
inline

Increases the amount of storage allocated if it is less than a given amount.

This will retain any data currently held in the array, but will add extra space at the end to make sure there it's at least as big as the size passed in. If it's already bigger, no action is taken.

Parameters
minNumElementsthe minimum number of elements that are needed

Definition at line 93 of file juce_ArrayAllocationBase.h.

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

◆ shrinkToNoMoreThan()

template<class ElementType , class TypeOfCriticalSectionToUse >
void juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::shrinkToNoMoreThan ( int  maxNumElements)
inline

Minimises the amount of storage allocated so that it's no more than the given number of elements.

Definition at line 104 of file juce_ArrayAllocationBase.h.

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

◆ swapWith()

template<class ElementType , class TypeOfCriticalSectionToUse >
void juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::swapWith ( ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse > &  other)
inlinenoexcept

Swap the contents of two objects.

Definition at line 111 of file juce_ArrayAllocationBase.h.

Member Data Documentation

◆ elements

template<class ElementType , class TypeOfCriticalSectionToUse >
HeapBlock<ElementType> juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::elements

Definition at line 118 of file juce_ArrayAllocationBase.h.

◆ numAllocated

template<class ElementType , class TypeOfCriticalSectionToUse >
int juce::ArrayAllocationBase< ElementType, TypeOfCriticalSectionToUse >::numAllocated = 0

Definition at line 119 of file juce_ArrayAllocationBase.h.


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