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.

Methods

bool

append ( int value )

void

append_array ( PackedInt32Array array )

int

bsearch ( int value, bool before=true )

PackedInt32Array

duplicate ( )

void

fill ( int value )

bool

has ( int value ) const

int

insert ( int at_index, int value )

bool

is_empty ( ) const

bool

push_back ( int value )

void

remove ( int index )

int

resize ( int new_size )

void

reverse ( )

void

set ( int index, int value )

int

size ( ) const

void

sort ( )

PackedInt32Array

subarray ( int from, int to ) const

PackedByteArray

to_byte_array ( ) const

Constructor Descriptions

Constructs an empty PackedInt32Array.

Constructs a PackedInt32Array as a copy of the given PackedInt32Array.

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

Method Descriptions

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

Appends a PackedInt32Array at the end of this array.

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.

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.

Returns true if the array contains 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.

Appends a value to the array.

  • void remove ( int index )

Removes an element from the array by index.

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.

  • void set ( int index, int value )

Changes the integer at the given index.

  • int size ( ) const

Returns the array size.

  • void sort ( )

Sorts the elements of the array in ascending order.

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 != ( )

  • bool operator == ( )

  • int operator [] ( int index )