PoolIntArray¶

A pooled array of integers (int).

Description¶

An array specifically designed to hold integer values (int). 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 PoolIntArray or mutating a PoolIntArray within an Array or Dictionary, changes will be lost:

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

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

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

Note: This type is limited to signed 32-bit integers, which means it can only take values in the interval [-2^31, 2^31 - 1], i.e. [-2147483648, 2147483647]. Exceeding those bounds will wrap around. In comparison, int uses signed 64-bit integers which can hold much larger values.

Methods¶

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

Method Descriptions¶

PoolIntArray PoolIntArray ( Array from )

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

void append ( int integer )

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

void append_array ( PoolIntArray array )

Appends a PoolIntArray at the end of this array.

void clear ( )

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

int count ( int value )

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

bool empty ( )

Returns true if the array is empty.

void fill ( int integer )

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 ( int 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 ( int value )

Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.

int insert ( int idx, int integer )

Inserts a new int 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 ( int integer )

Appends a value to 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 ( int 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, int integer )

Changes the int 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.