PoolRealArray

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:

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

PoolRealArray property must be reassigned with = for it to be changed:

  1. var array = [PoolRealArray()]var pool_array = array[0]pool_array.push_back(12.34)array[0] = pool_arrayprint(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

Method Descriptions

  • PoolRealArray PoolRealArray ( Array from ) PoolRealArray. Optionally, you can pass in a generic Array that will be converted.
  • append ( float value ) push_back).
  • append_array ( PoolRealArray array ) PoolRealArray at the end of this array.
  • int count ( float value ) Returns the number of times an element is in the array.
  • bool empty ( ) true if the array is empty.
  • fill ( float value ) resize to create an array with a given size and initialized elements.
  • int find ( float value, int from=0 ) -1 if not found. Optionally, the initial search index can be passed. Returns -1 if from is out of bounds.
  • bool has ( float value ) true if the array contains the given value. Note: This is equivalent to using the in operator.
  • int insert ( int idx, float value ) idx == size()).
  • invert ( ) Reverses the order of the elements in the array.
  • push_back ( float value ) Appends an element at the end of the array.
  • remove ( int idx ) Removes an element from the array by index.
  • 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.
  • set ( int idx, float value ) Changes the float at the given index.
  • int size ( ) Returns the number of elements in the array.
  • sort ( ) Sorts the elements of the array in ascending order.