Interface Float32Array
[toStringTag]: "Float32Array";
buffer: ArrayBufferLike;
byteLength: number;
byteOffset: number;
BYTES_PER_ELEMENT: number;
length: number;
[iterator](): ArrayIterator<number>;
at(index: number): number;
copyWithin(target: number, start: number, end?: number): this;
entries(): ArrayIterator<[number, number]>;
every(predicate: ((value: number, index: number, array: Float32Array) => unknown), thisArg?: any): boolean;
fill(value: number, start?: number, end?: number): this;
filter(predicate: ((value: number, index: number, array: Float32Array) => any), thisArg?: any): Float32Array;
find(predicate: ((value: number, index: number, obj: Float32Array) => boolean), thisArg?: any): number;
findIndex(predicate: ((value: number, index: number, obj: Float32Array) => boolean), thisArg?: any): number;
findLast<S>(predicate: ((value: number, index: number, array: Float32Array) => value is S), thisArg?: any): S;
findLast(predicate: ((value: number, index: number, array: Float32Array) => unknown), thisArg?: any): number;
findLastIndex(predicate: ((value: number, index: number, array: Float32Array) => unknown), thisArg?: any): number;
forEach(callbackfn: ((value: number, index: number, array: Float32Array) => void), thisArg?: any): void;
includes(searchElement: number, fromIndex?: number): boolean;
indexOf(searchElement: number, fromIndex?: number): number;
join(separator?: string): string;
keys(): ArrayIterator<number>;
lastIndexOf(searchElement: number, fromIndex?: number): number;
map(callbackfn: ((value: number, index: number, array: Float32Array) => number), thisArg?: any): Float32Array;
reduce(callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)): number;
reduce(callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number), initialValue: number): number;
reduce<U>(callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U), initialValue: U): U;
reduceRight(callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)): number;
reduceRight(callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number), initialValue: number): number;
reduceRight<U>(callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U), initialValue: U): U;
reverse(): Float32Array;
set(array: ArrayLike<number>, offset?: number): void;
slice(start?: number, end?: number): Float32Array;
some(predicate: ((value: number, index: number, array: Float32Array) => unknown), thisArg?: any): boolean;
sort(compareFn?: ((a: number, b: number) => number)): this;
subarray(begin?: number, end?: number): Float32Array;
toLocaleString(): string;
toLocaleString(locales: string | string[], options?: NumberFormatOptions): string;
toReversed(): Float32Array;
toSorted(compareFn?: ((a: number, b: number) => number)): Float32Array;
toString(): string;
valueOf(): Float32Array;
values(): ArrayIterator<number>;
with(index: number, value: number): Float32Array;
[index: number]: number;
}
Indexable
- [index: number]: number
Index
Properties
Methods
Properties
Readonly
[toStringTag]
Readonly
buffer
Readonly
byteLength
The length in bytes of the array.
Readonly
byteOffset
The offset in bytes of the array.
Readonly
BYTES_PER_ELEMENT
The size in bytes of each element in the array.
Readonly
length
The length of the array.
Methods
[iterator]
- [iterator](): ArrayIterator<number>
Returns ArrayIterator<number>
at
copyWithin
- copy
Within (target, start, end?): this Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
Parameters
- target: number
If target is negative, it is treated as length+target where length is the length of the array.
- start: number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
Returns this
- target: number
entries
- entries(): ArrayIterator<[number, number]>
Returns an array of key, value pairs for every entry in the array
Returns ArrayIterator<[number, number]>
every
- every(predicate, thisArg?): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
- (value, index, array): unknown
Parameters
- value: number
- index: number
- array: Float32Array
Returns unknown
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
fill
- fill(value, start?, end?): this
Changes all array elements from
start
toend
index to a staticvalue
and returns the modified arrayParameters
- value: number
value to fill array section with
Optional
start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional
end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
Returns this
- value: number
filter
- filter(predicate, thisArg?): Float32Array
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: ((value: number, index: number, array: Float32Array) => any)
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
- (value, index, array): any
Parameters
- value: number
- index: number
- array: Float32Array
Returns any
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array
- predicate: ((value: number, index: number, array: Float32Array) => any)
find
- find(predicate, thisArg?): number
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
- predicate: ((value: number, index: number, obj: Float32Array) => boolean)
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
- (value, index, obj): boolean
Parameters
- value: number
- index: number
- obj: Float32Array
Returns boolean
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
- predicate: ((value: number, index: number, obj: Float32Array) => boolean)
findIndex
- find
Index (predicate, thisArg?): number Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: ((value: number, index: number, obj: Float32Array) => boolean)
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
- (value, index, obj): boolean
Parameters
- value: number
- index: number
- obj: Float32Array
Returns boolean
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
- predicate: ((value: number, index: number, obj: Float32Array) => boolean)
findLast
- find
Last <S>(predicate, thisArg?): S Returns the value of the last element in the array where predicate is true, and undefined otherwise.
Type Parameters
Parameters
- predicate: ((value: number, index: number, array: Float32Array) => value is S)
findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.
- (value, index, array): value is S
Parameters
- value: number
- index: number
- array: Float32Array
Returns value is S
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S
- predicate: ((value: number, index: number, array: Float32Array) => value is S)
- find
Last (predicate, thisArg?): number Parameters
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
- (value, index, array): unknown
Parameters
- value: number
- index: number
- array: Float32Array
Returns unknown
Optional
thisArg: any
Returns number
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
findLastIndex
- find
Last (predicate, thisArg?): numberIndex Returns the index of the last element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
- (value, index, array): unknown
Parameters
- value: number
- index: number
- array: Float32Array
Returns unknown
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
forEach
- for
Each (callbackfn, thisArg?): void Performs the specified action for each element in an array.
Parameters
- callbackfn: ((value: number, index: number, array: Float32Array) => void)
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
- (value, index, array): void
Parameters
- value: number
- index: number
- array: Float32Array
Returns void
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
- callbackfn: ((value: number, index: number, array: Float32Array) => void)
includes
- includes(searchElement, fromIndex?): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
- searchElement: number
The element to search for.
Optional
fromIndex: numberThe position in this array at which to begin searching for searchElement.
Returns boolean
- searchElement: number
indexOf
- index
Of (searchElement, fromIndex?): number Returns the index of the first occurrence of a value in an array.
Parameters
- searchElement: number
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
- searchElement: number
join
- join(separator?): string
Adds all the elements of an array separated by the specified separator string.
Parameters
Optional
separator: stringA string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string
keys
- keys(): ArrayIterator<number>
Returns an list of keys in the array
Returns ArrayIterator<number>
lastIndexOf
- last
Index (searchElement, fromIndex?): numberOf Returns the index of the last occurrence of a value in an array.
Parameters
- searchElement: number
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
- searchElement: number
map
- map(callbackfn, thisArg?): Float32Array
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
- callbackfn: ((value: number, index: number, array: Float32Array) => number)
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
- (value, index, array): number
Parameters
- value: number
- index: number
- array: Float32Array
Returns number
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array
- callbackfn: ((value: number, index: number, array: Float32Array) => number)
reduce
- reduce(callbackfn): number
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- (previousValue, currentValue, currentIndex, array): number
Parameters
- previousValue: number
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns number
Returns number
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- reduce(callbackfn, initialValue): number
Parameters
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- (previousValue, currentValue, currentIndex, array): number
Parameters
- previousValue: number
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns number
- initialValue: number
Returns number
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- reduce<U>(callbackfn, initialValue): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
Parameters
- callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- (previousValue, currentValue, currentIndex, array): U
Parameters
- previousValue: U
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns U
- initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
- callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)
reduceRight
- reduce
Right (callbackfn): number Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
- (previousValue, currentValue, currentIndex, array): number
Parameters
- previousValue: number
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns number
Returns number
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- reduce
Right (callbackfn, initialValue): number Parameters
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- (previousValue, currentValue, currentIndex, array): number
Parameters
- previousValue: number
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns number
- initialValue: number
Returns number
- callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
- reduce
Right <U>(callbackfn, initialValue): U Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
Parameters
- callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
- (previousValue, currentValue, currentIndex, array): U
Parameters
- previousValue: U
- currentValue: number
- currentIndex: number
- array: Float32Array
Returns U
- initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
- callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)
reverse
- reverse(): Float32Array
Reverses the elements in an Array.
Returns Float32Array
set
- set(array, offset?): void
Sets a value or an array of values.
Parameters
- array: ArrayLike<number>
A typed or untyped array of values to set.
Optional
offset: numberThe index in the current array at which the values are to be written.
Returns void
- array: ArrayLike<number>
slice
- slice(start?, end?): Float32Array
Returns a section of an array.
Parameters
Optional
start: numberThe beginning of the specified portion of the array.
Optional
end: numberThe end of the specified portion of the array. This is exclusive of the element at the index 'end'.
Returns Float32Array
some
- some(predicate, thisArg?): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
- (value, index, array): unknown
Parameters
- value: number
- index: number
- array: Float32Array
Returns unknown
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
- predicate: ((value: number, index: number, array: Float32Array) => unknown)
sort
- sort(compareFn?): this
Sorts an array.
Parameters
Optional
compareFn: ((a: number, b: number) => number)Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
- (a, b): number
Parameters
- a: number
- b: number
Returns number
Returns this
subarray
- subarray(begin?, end?): Float32Array
Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
Optional
begin: numberThe index of the beginning of the array.
Optional
end: numberThe index of the end of the array.
Returns Float32Array
toLocaleString
- to
Locale (): stringString Converts a number to a string by using the current locale.
Returns string
- to
Locale (locales, options?): stringString Parameters
- locales: string | string[]
Optional
options: NumberFormatOptions
Returns string
toReversed
- to
Reversed (): Float32Array Copies the array and returns the copy with the elements in reverse order.
Returns Float32Array
toSorted
- to
Sorted (compareFn?): Float32Array Copies and sorts the array.
Parameters
Optional
compareFn: ((a: number, b: number) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.
const myNums = Float32Array.from([11.25, 2, -22.5, 1]);
myNums.toSorted((a, b) => a - b) // Float32Array(4) [-22.5, 1, 2, 11.5]- (a, b): number
Parameters
- a: number
- b: number
Returns number
Returns Float32Array
toString
valueOf
- value
Of (): Float32Array Returns the primitive value of the specified object.
Returns Float32Array
values
- values(): ArrayIterator<number>
Returns an list of values in the array
Returns ArrayIterator<number>
with
- with(index, value): Float32Array
Copies the array and inserts the given number at the provided index.
Parameters
- index: number
The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
- value: number
The value to insert into the copied array.
Returns Float32Array
A copy of the original array with the inserted value.
- index: number
The ArrayBuffer instance referenced by the array.