PackedInt32Array

A packed array of 32-bit integers.

Description

An array specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes.

Note: This type stores signed 32-bit integers, which means it can 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. If you need to pack 64-bit integers tightly, see PackedInt64Array.

Constructors

PackedInt32Array

PackedInt32Array ( )

PackedInt32Array

PackedInt32Array ( PackedInt32Array from )

PackedInt32Array

PackedInt32Array ( Array from )

Methods

bool

append ( int value )

void

append_array ( PackedInt32Array array )

int

bsearch ( int value, bool before=true )

void

clear ( )

int

count ( int value ) const

PackedInt32Array

duplicate ( )

void

fill ( int value )

int

find ( int value, int from=0 ) const

bool

has ( int value ) const

int

insert ( int at_index, int value )

bool

is_empty ( ) const

bool

push_back ( int value )

void

remove_at ( int index )

int

resize ( int new_size )

void

reverse ( )

int

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

void

set ( int index, int value )

int

size ( ) const

PackedInt32Array

slice ( int begin, int end=2147483647 ) const

void

sort ( )

PackedByteArray

to_byte_array ( ) const

Operators

bool

operator != ( PackedInt32Array right )

PackedInt32Array

operator + ( PackedInt32Array right )

bool

operator == ( PackedInt32Array right )

int

operator [] ( int index )


Constructor Descriptions

PackedInt32Array PackedInt32Array ( )

Constructs an empty PackedInt32Array.


PackedInt32Array PackedInt32Array ( PackedInt32Array from )

Constructs a PackedInt32Array as a copy of the given PackedInt32Array.


PackedInt32Array PackedInt32Array ( Array from )

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


Method Descriptions

bool append ( int value )

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


void append_array ( PackedInt32Array array )

Appends a PackedInt32Array at the end of this array.


int bsearch ( int value, bool before=true )

Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch on an unsorted array results in unexpected behavior.


void clear ( )

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


int count ( int value ) const

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


PackedInt32Array duplicate ( )

Creates a copy of the array, and returns it.


void fill ( int 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 ( int value, int from=0 ) const

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


bool has ( int value ) const

Returns true if the array contains value.


int insert ( int at_index, int value )

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


bool is_empty ( ) const

Returns true if the array is empty.


bool push_back ( int value )

Appends a value to the array.


void remove_at ( int index )

Removes an element from the array by index.


int resize ( int new_size )

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.


void reverse ( )

Reverses the order of the elements in the array.


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

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.


void set ( int index, int value )

Changes the integer at the given index.


int size ( ) const

Returns the number of elements in the array.


PackedInt32Array slice ( int begin, int end=2147483647 ) const

Returns the slice of the PackedInt32Array, from begin (inclusive) to end (exclusive), as a new PackedInt32Array.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).


void sort ( )

Sorts the elements of the array in ascending order.


PackedByteArray to_byte_array ( ) const

Returns a copy of the data converted to a PackedByteArray, where each element have been encoded as 4 bytes.

The size of the new array will be int32_array.size() * 4.


Operator Descriptions

bool operator != ( PackedInt32Array right )

Returns true if contents of the arrays differ.


PackedInt32Array operator + ( PackedInt32Array right )

Returns a new PackedInt32Array with contents of right added at the end of this array. For better performance, consider using append_array instead.


bool operator == ( PackedInt32Array right )

Returns true if contents of both arrays are the same, i.e. they have all equal ints at the corresponding indices.


int operator [] ( int index )

Returns the int at index index. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.

Note that int type is 64-bit, unlike the values stored in the array.