PackedFloat64Array (original) (raw)

A packed array of 64-bit floating-point values.

Description

An array specifically designed to hold 64-bit floating-point values (double). Packs data tightly, so it saves memory for large array sizes.

If you only need to pack 32-bit floats tightly, see PackedFloat32Array for a more memory-friendly alternative.

Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. PackedFloat64Array versus Array[float]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as Array.map(). Typed arrays are in turn faster to iterate on and modify than untyped arrays.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate(). This is not the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will not affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.

Constructors

Methods

Operators

Constructor Descriptions

PackedFloat64Array PackedFloat64Array() 🔗

Constructs an empty PackedFloat64Array.

PackedFloat64Array PackedFloat64Array(from: PackedFloat64Array)

Constructs a PackedFloat64Array as a copy of the given PackedFloat64Array.

PackedFloat64Array PackedFloat64Array(from: Array)

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

Method Descriptions

bool append(value: float) 🔗

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

void append_array(array: PackedFloat64Array) 🔗

Appends a PackedFloat64Array at the end of this array.

int bsearch(value: float, before: bool = 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.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

void clear() 🔗

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

int count(value: float) const 🔗

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

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

PackedFloat64Array duplicate() 🔗

Creates a copy of the array, and returns it.

bool erase(value: float) 🔗

Removes the first occurrence of a value from the array and returns true. If the value does not exist in the array, nothing happens and false is returned. To remove an element by index, use remove_at() instead.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

void fill(value: float) 🔗

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(value: float, from: int = 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.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

float get(index: int) const 🔗

Returns the 64-bit float at the given index in the array. This is the same as using the [] operator (array[index]).

bool has(value: float) const 🔗

Returns true if the array contains value.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

int insert(at_index: int, value: float) 🔗

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()).

bool is_empty() const 🔗

Returns true if the array is empty.

bool push_back(value: float) 🔗

Appends an element at the end of the array.

void remove_at(index: int) 🔗

Removes an element from the array by index.

int resize(new_size: int) 🔗

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. Calling resize() once and assigning the new values is faster than adding new elements one by one.

Returns @GlobalScope.OK on success, or one of the following Error constants if this method fails: @GlobalScope.ERR_INVALID_PARAMETER if the size is negative, or @GlobalScope.ERR_OUT_OF_MEMORY if allocations fail. Use size() to find the actual size of the array after resize.

void reverse() 🔗

Reverses the order of the elements in the array.

int rfind(value: float, from: int = -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.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

void set(index: int, value: float) 🔗

Changes the float at the given index.

int size() const 🔗

Returns the number of elements in the array.

PackedFloat64Array slice(begin: int, end: int = 2147483647) const 🔗

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

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.

Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

PackedByteArray to_byte_array() const 🔗

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

The size of the new array will be float64_array.size() * 8.

Operator Descriptions

bool operator !=(right: PackedFloat64Array) 🔗

Returns true if contents of the arrays differ.

PackedFloat64Array operator +(right: PackedFloat64Array) 🔗

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

bool operator ==(right: PackedFloat64Array) 🔗

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

float operator [](index: int) 🔗

Returns the float 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.