arrays.index_to_float
arrays.index_to_float(array, index)
Description
Returns the element at the given index of an array. The element at that index is returned as a float.
The index is an integer value which represents the position of an element in the array. By default, the first element of an array has an index of 0, and the last element has an index of n-1, where n is the size of the array. Negative indexing allows accessing array elements relative to the end of the array. For example, an index of -1 refers to the last element in the array and an index of -2 refers to the second to last element in the array.
Param data types
ARRAY_STRINGS|ARRAY_INTS|ARRAY_FLOATS, INT
Return type
FLOAT
Code samples
Example 1
The following example fetches an element at index 1 from an array of floats.
arrays.index_to_float([1.2, 2.1, 3.5, 4.6], 1) // 2.1
Example 2
The following example fetches an element at index -1 from an array of floats.
arrays.index_to_float([1.2, 2.1, 3.5, 4.6], 0-1) // 4.6
Example 3
The following example fetches an element for an index greater than the size of the array.
arrays.index_to_float([1.2, 2.1, 3.5, 4.6], 6) // 0.0
Example 4
The following example fetches an element from an empty array.
arrays.index_to_float([], 0) // 0.0
Example 5
The following example fetches an element at index 1 from a string array.
arrays.index_to_float(["1.2", "3.3", "2.4"], 1) // 3.3
Example 6
The following example fetches an element at index 2 from an array of integers.
arrays.index_to_float([1, 3, 2], 2) // 2.0