PoolRealArray¶

A pooled array of real numbers (float).

Description¶

An array specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference. This means that when mutating a class property of type PoolRealArray or mutating a PoolRealArray within an Array or Dictionary, changes will be lost:

var array = [PoolRealArray()]
array[0].push_back(12.34)
print(array)  # [[]] (empty PoolRealArray within an Array)

Instead, the entire PoolRealArray property must be reassigned with = for it to be changed:

var array = [PoolRealArray()]
var pool_array = array[0]
pool_array.push_back(12.34)
array[0] = pool_array
print(array)  # [[12.34]] (PoolRealArray with 1 element inside an Array)

Note: Unlike primitive floats which are 64-bit, numbers stored in PoolRealArray are 32-bit floats. This means values stored in PoolRealArray have lower precision compared to primitive floats. If you need to store 64-bit floats in an array, use a generic Array with float elements as these will still be 64-bit. However, using a generic Array to store floats will use roughly 6 times more memory compared to a PoolRealArray.

Methods¶

PoolRealArray	PoolRealArray ( Array from )
void	append ( float value )
void	append_array ( PoolRealArray array )
void	clear ( )
int	count ( float value )
bool	empty ( )
void	fill ( float value )
int	find ( float value, int from=0 )
bool	has ( float value )
int	insert ( int idx, float value )
void	invert ( )
void	push_back ( float value )
void	remove ( int idx )
void	resize ( int idx )
int	rfind ( float value, int from=-1 )
void	set ( int idx, float value )
int	size ( )
void	sort ( )

Method Descriptions¶

PoolRealArray PoolRealArray ( Array from )

Constructs a new PoolRealArray. Optionally, you can pass in a generic Array that will be converted.

void append ( float value )

Appends an element at the end of the array (alias of push_back).

void append_array ( PoolRealArray array )

Appends a PoolRealArray at the end of this array.

void clear ( )

Clears the array. This is equivalent to using resize with a size of 0.

int count ( float value )

Returns the number of times an element is in the array.

bool empty ( )

Returns true if the array is empty.

void fill ( float value )

Assigns the given value to all elements in the array. This can typically be used together with resize to create an array with a given size and initialized elements.

int find ( float value, int from=0 )

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. Returns -1 if from is out of bounds.

bool has ( float value )

Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.

int insert ( int idx, float value )

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

void invert ( )

Reverses the order of the elements in the array.

void push_back ( float value )

Appends an element at the end of the array.

void remove ( int idx )

Removes an element from the array by index.

void resize ( int idx )

Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.

Note: Added elements are not automatically initialized to 0 and will contain garbage, i.e. indeterminate values.

int rfind ( float value, int from=-1 )

Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. If the adjusted start index is out of bounds, this method searches from the end of the array.

void set ( int idx, float value )

Changes the float at the given index.

int size ( )

Returns the number of elements in the array.

void sort ( )

Sorts the elements of the array in ascending order.