Usage
var Float32Array = require( '@stdlib/array-float32' );
Float32Array()
A typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.
var arr = new Float32Array();
Float32Array( length )
Returns a typed array having a specified length.
var arr = new Float32Array( 5 );
Float32Array( typedarray )
Creates a typed array from another typed array.
var Float64Array = require( '@stdlib/array-float64' );
var arr1 = new Float64Array( [ 0.5, 0.5, 0.5 ] );
var arr2 = new Float32Array( arr1 );
Float32Array( obj )
Creates a typed array from an array-like object
or iterable.
var arr = new Float32Array( [ 0.5, 0.5, 0.5 ] );
Float32Array( buffer[, byteOffset[, length]] )
Returns a typed array view of an ArrayBuffer
.
var ArrayBuffer = require( '@stdlib/array-buffer' );
var buf = new ArrayBuffer( 16 );
var arr = new Float32Array( buf, 0, 4 );
Properties
Float32Array.BYTES_PER_ELEMENT
Number of bytes per view element.
var nbytes = Float32Array.BYTES_PER_ELEMENT;
Float32Array.name
Typed array constructor name.
var str = Float32Array.name;
Float32Array.prototype.buffer
Read-only property which returns the ArrayBuffer
referenced by the typed array.
var arr = new Float32Array( 5 );
var buf = arr.buffer;
Float32Array.prototype.byteLength
Read-only property which returns the length (in bytes) of the typed array.
var arr = new Float32Array( 5 );
var byteLength = arr.byteLength;
Float32Array.prototype.byteOffset
Read-only property which returns the offset (in bytes) of the typed array from the start of its ArrayBuffer
.
var arr = new Float32Array( 5 );
var byteOffset = arr.byteOffset;
Float32Array.prototype.BYTES_PER_ELEMENT
Number of bytes per view element.
var arr = new Float32Array( 5 );
var nbytes = arr.BYTES_PER_ELEMENT;
Float32Array.prototype.length
Read-only property which returns the number of view elements.
var arr = new Float32Array( 5 );
var len = arr.length;
Methods
Float32Array.from( src[, map[, thisArg]] )
Creates a new typed array from an array-like object
or an iterable.
var arr = Float32Array.from( [ 1.0, 2.0 ] );
To invoke a function for each src
value, provide a callback function.
function mapFcn( v ) {
return v * 2.0;
}
var arr = Float32Array.from( [ 1.0, 2.0 ], mapFcn );
A callback function is provided two arguments:
value
: source valueindex
: source index
To set the callback execution context, provide a thisArg
.
function mapFcn( v ) {
this.count += 1;
return v * 2.0;
}
var ctx = {
'count': 0
};
var arr = Float32Array.from( [ 1.0, 2.0 ], mapFcn, ctx );
var n = ctx.count;
Float32Array.of( element0[, element1[, ...elementN]] )
Creates a new typed array from a variable number of arguments.
var arr = Float32Array.of( 1.0, 2.0 );
Float32Array.prototype.copyWithin( target, start[, end] )
Copies a sequence of elements within an array starting at start
and ending at end
(non-inclusive) to the position starting at target
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
arr.copyWithin( 0, 3 );
var v = arr[ 0 ];
v = arr[ 1 ];
By default, end
equals the number of array elements (i.e., one more than the last array index). To limit the sequence length, provide an end
argument.
var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
arr.copyWithin( 3, 0, 2 );
var v = arr[ 3 ];
v = arr[ 4 ];
When a target
, start
, and/or end
index is negative, the respective index is determined relative to the last array element. The following example achieves the same behavior as the previous example:
var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
arr.copyWithin( -2, -5, -3 );
var v = arr[ 3 ];
v = arr[ 4 ];
Float32Array.prototype.entries()
Returns an iterator for iterating over array key-value pairs.
var arr = new Float32Array( [ 1.0, 2.0 ] );
var it = arr.entries();
var v = it.next().value;
v = it.next().value;
var bool = it.next().done;
Float32Array.prototype.every( predicate[, thisArg] )
Tests whether all array elements pass a test implemented by a predicate
function.
function predicate( v ) {
return ( v <= 1.0 );
}
var arr = new Float32Array( [ 1.0, 2.0 ] );
var bool = arr.every( predicate );
A predicate
function is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function predicate( v ) {
this.count += 1;
return ( v >= 1.0 );
}
var ctx = {
'count': 0
};
var arr = new Float32Array( [ 1.0, 2.0 ] );
var bool = arr.every( predicate, ctx );
var n = ctx.count;
Float32Array.prototype.fill( value[, start[, end]] )
Fills an array from a start
index to an end
index (non-inclusive) with a provided value
.
var arr = new Float32Array( 2 );
arr.fill( 2.0 );
var v = arr[ 0 ];
v = arr[ 1 ];
arr.fill( 3.0, 1 );
v = arr[ 0 ];
v = arr[ 1 ];
arr.fill( 4.0, 0, arr.length-1 );
v = arr[ 0 ];
v = arr[ 1 ];
When a start
and/or end
index is negative, the respective index is determined relative to the last array element.
var arr = new Float32Array( 2 );
arr.fill( 2.0, -arr.length, -1 );
var v = arr[ 0 ];
v = arr[ 1 ];
Float32Array.prototype.filter( predicate[, thisArg] )
Creates a new array (of the same data type as the host array) which includes those elements for which a predicate
function returns a truthy value.
function predicate( v ) {
return ( v >= 2.0 );
}
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.filter( predicate );
If a predicate
function does not return a truthy value for any array element, the method returns an empty array.
function predicate( v ) {
return ( v >= 10.0 );
}
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.filter( predicate );
A predicate
function is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function predicate( v ) {
this.count += 1;
return ( v >= 2.0 );
}
var ctx = {
'count': 0
};
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.filter( predicate, ctx );
var n = ctx.count;
Float32Array.prototype.find( predicate[, thisArg] )
Returns the first array element for which a provided predicate
function returns a truthy value.
function predicate( v ) {
return ( v > 2.0 );
}
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var v = arr.find( predicate );
If a predicate
function does not return a truthy value for any array element, the method returns undefined
.
function predicate( v ) {
return ( v < 1.0 );
}
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var v = arr.find( predicate );
A predicate
function is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function predicate( v ) {
this.count += 1;
return ( v > 2.0 );
}
var ctx = {
'count': 0
};
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var v = arr.find( predicate, ctx );
var n = ctx.count;
Float32Array.prototype.findIndex( predicate[, thisArg] )
Returns the index of the first array element for which a provided predicate
function returns a truthy value.
function predicate( v ) {
return ( v >= 3.0 );
}
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.findIndex( predicate );
If a predicate
function does not return a truthy value for any array element, the method returns -1
.
function predicate( v ) {
return ( v < 1.0 );
}
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.findIndex( predicate );
A predicate
function is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function predicate( v ) {
this.count += 1;
return ( v >= 3.0 );
}
var ctx = {
'count': 0
};
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.findIndex( predicate, ctx );
var n = ctx.count;
Float32Array.prototype.forEach( fcn[, thisArg] )
Invokes a callback for each array element.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var str = '';
function fcn( v, i ) {
str += i + ':' + v;
if ( i < arr.length-1 ) {
str += ' ';
}
}
arr.forEach( fcn );
console.log( str );
The callback is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function fcn() {
this.count += 1;
}
var ctx = {
'count': 0
};
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
arr.forEach( fcn, ctx );
var n = ctx.count;
Float32Array.prototype.includes( searchElement[, fromIndex] )
Returns a boolean
indicating whether an array includes a search element.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var bool = arr.includes( 3.0 );
bool = arr.includes( 0.0 );
By default, the method searches the entire array (fromIndex = 0
). To begin searching from a specific array index, provide a fromIndex
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var bool = arr.includes( 1.0, 1 );
When a fromIndex
is negative, the starting index is resolved relative to the last array element.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
bool = arr.includes( 1.0, -2 );
The method does not distinguish between signed and unsigned zero.
Float32Array.prototype.indexOf( searchElement[, fromIndex] )
Returns the index of the first array element strictly equal to a search element.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.indexOf( 3.0 );
idx = arr.indexOf( 0.0 );
By default, the method searches the entire array (fromIndex = 0
). To begin searching from a specific array index, provide a fromIndex
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.indexOf( 1.0, 1 );
When a fromIndex
is negative, the starting index is resolved relative to the last array element.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var idx = arr.indexOf( 1.0, -2 );
The method does not distinguish between signed and unsigned zero.
Float32Array.prototype.join( [separator] )
Serializes an array by joining all array elements as a string.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var str = arr.join();
By default, the method delineates array elements using a comma ,
. To specify a custom separator, provide a separator
string.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var str = arr.join( '|' );
Float32Array.prototype.keys()
Returns an iterator for iterating over array keys.
var arr = new Float32Array( [ 1.0, 2.0 ] );
var it = arr.keys();
var v = it.next().value;
v = it.next().value;
var bool = it.next().done;
Float32Array.prototype.lastIndexOf( searchElement[, fromIndex] )
Returns the index of the last array element strictly equal to a search element, iterating from right to left.
var arr = new Float32Array( [ 1.0, 0.0, 2.0, 0.0, 1.0 ] );
var idx = arr.lastIndexOf( 0.0 );
idx = arr.lastIndexOf( 3.0 );
By default, the method searches the entire array (fromIndex = -1
). To begin searching from a specific array index, provide a fromIndex
.
var arr = new Float32Array( [ 1.0, 0.0, 2.0, 0.0, 1.0 ] );
var idx = arr.lastIndexOf( 0.0, 2 );
When a fromIndex
is negative, the starting index is resolved relative to the last array element.
var arr = new Float32Array( [ 1.0, 0.0, 2.0, 0.0, 1.0 ] );
var idx = arr.lastIndexOf( 0.0, -3 );
The method does not distinguish between signed and unsigned zero.
Float32Array.prototype.map( fcn[, thisArg] )
Maps each array element to an element in a new array having the same data type as the host array.
function fcn( v ) {
return v * 2.0;
}
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.map( fcn );
A callback is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function fcn( v ) {
this.count += 1;
return v * 2.0;
}
var ctx = {
'count': 0
};
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.map( fcn, ctx );
var n = ctx.count;
Float32Array.prototype.reduce( fcn[, initialValue] )
Applies a function against an accumulator and each element in an array and returns the accumulated result.
function fcn( acc, v ) {
return acc + ( v*v );
}
var arr = new Float32Array( [ 2.0, 1.0, 3.0 ] );
var v = arr.reduce( fcn );
If not provided an initial value, the method invokes a provided function with the first array element as the first argument and the second array element as the second argument.
If provided an initial value, the method invokes a provided function with the initial value as the first argument and the first array element as the second argument.
function fcn( acc, v ) {
return acc + ( v*v );
}
var arr = new Float32Array( [ 2.0, 1.0, 3.0 ] );
var v = arr.reduce( fcn, 0.0 );
A callback is provided four arguments:
acc
: accumulated resultvalue
: array elementindex
: array indexarr
: array on which the method is invoked
Float32Array.prototype.reduceRight( fcn[, initialValue] )
Applies a function against an accumulator and each element in an array and returns the accumulated result, iterating from right to left.
function fcn( acc, v ) {
return acc + ( v*v );
}
var arr = new Float32Array( [ 2.0, 1.0, 3.0 ] );
var v = arr.reduceRight( fcn );
If not provided an initial value, the method invokes a provided function with the last array element as the first argument and the second-to-last array element as the second argument.
If provided an initial value, the method invokes a provided function with the initial value as the first argument and the last array element as the second argument.
function fcn( acc, v ) {
return acc + ( v*v );
}
var arr = new Float32Array( [ 2.0, 1.0, 3.0 ] );
var v = arr.reduce( fcn, 0.0 );
A callback is provided four arguments:
acc
: accumulated resultvalue
: array elementindex
: array indexarr
: array on which the method is invoked
Float32Array.prototype.reverse()
Reverses an array in-place (thus mutating the array on which the method is invoked).
var arr = new Float32Array( [ 2.0, 0.0, 3.0 ] );
arr.reverse();
var v = arr[ 0 ];
v = arr[ 1 ];
v = arr[ 2 ];
Float32Array.prototype.set( arr[, offset] )
Sets array elements.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
arr.set( [ 4.0, 5.0 ] );
var v = arr[ 0 ];
v = arr[ 1 ];
By default, the method starts writing values at the first array index. To specify an alternative index, provide an index offset
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
arr.set( [ 4.0, 5.0 ], 1 );
var v = arr[ 1 ];
v = arr[ 2 ];
Float32Array.prototype.slice( [begin[, end]] )
Copies array elements to a new array with the same underlying data type as the host array.
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.slice();
var bool = ( arr1 === arr2 );
bool = ( arr1.buffer === arr2.buffer );
var v = arr2[ 0 ];
v = arr2[ 1 ];
v = arr2[ 2 ];
By default, the method copies elements beginning with the first array element. To specify an alternative array index at which to begin copying, provide a begin
index (inclusive).
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.slice( 1 );
var len = arr2.length;
var v = arr2[ 0 ];
v = arr2[ 1 ];
By default, the method copies all array elements after begin
. To specify an alternative array index at which to end copying, provide an end
index (exclusive).
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.slice( 0, 2 );
var len = arr2.length;
var v = arr2[ 0 ];
v = arr2[ 1 ];
When a begin
and/or end
index is negative, the respective index is determined relative to the last array element.
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.slice( -arr1.length, -1 );
var len = arr2.length;
var v = arr2[ 0 ];
v = arr2[ 1 ];
Float32Array.prototype.some( predicate[, thisArg] )
Tests whether at least one array element passes a test implemented by a predicate
function.
function predicate( v ) {
return ( v >= 2.0 );
}
var arr = new Float32Array( [ 1.0, 2.0 ] );
var bool = arr.some( predicate );
A predicate
function is provided three arguments:
value
: array elementindex
: array indexarr
: array on which the method is invoked
To set the callback execution context, provide a thisArg
.
function predicate( v ) {
this.count += 1;
return ( v >= 2.0 );
}
var ctx = {
'count': 0
};
var arr = new Float32Array( [ 1.0, 1.0 ] );
var bool = arr.some( predicate, ctx );
var n = ctx.count;
Float32Array.prototype.sort( [compareFunction] )
Sorts an array in-place (thus mutating the array on which the method is invoked).
var arr = new Float32Array( [ 2.0, 3.0, 0.0 ] );
arr.sort();
var v = arr[ 0 ];
v = arr[ 1 ];
v = arr[ 2 ];
By default, the method sorts array elements in ascending order. To impose a custom order, provide a compareFunction
.
function descending( a, b ) {
return b - a;
}
var arr = new Float32Array( [ 2.0, 3.0, 0.0 ] );
arr.sort( descending );
var v = arr[ 0 ];
v = arr[ 1 ];
v = arr[ 2 ];
The comparison function is provided two array elements, a
and b
, per invocation, and its return value determines the sort order as follows:
- If the comparison function returns a value less than zero, then the method sorts
a
to an index lower than b
(i.e., a
should come before b
). - If the comparison function returns a value greater than zero, then the method sorts
a
to an index higher than b
(i.e., b
should come before a
). - If the comparison function returns zero, then the relative order of
a
and b
should remain unchanged.
Float32Array.prototype.subarray( [begin[, end]] )
Creates a new typed array view over the same underlying ArrayBuffer
and with the same underlying data type as the host array.
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.subarray();
var bool = ( arr1.buffer === arr2.buffer );
By default, the method creates a typed array view beginning with the first array element. To specify an alternative array index at which to begin, provide a begin
index (inclusive).
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.subarray( 1 );
var bool = ( arr1.buffer === arr2.buffer );
By default, the method creates a typed array view which includes all array elements after begin
. To limit the number of array elements after begin
, provide an end
index (exclusive).
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.subarray( 0, 2 );
var bool = ( arr1.buffer === arr2.buffer );
When a begin
and/or end
index is negative, the respective index is determined relative to the last array element.
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.subarray( -arr1.length, -1 );
var bool = ( arr1.buffer === arr2.buffer );
If the method is unable to resolve indices to a non-empty array subsequence, the method returns an empty typed array.
var arr1 = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var arr2 = arr1.subarray( 10, -1 );
Float32Array.prototype.toLocaleString( [locales[, options]] )
Serializes an array as a locale-specific string
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var str = arr.toLocaleString();
Float32Array.prototype.toString()
Serializes an array as a string
.
var arr = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var str = arr.toString();
Float32Array.prototype.values()
Returns an iterator for iterating over array elements.
var arr = new Float32Array( [ 1.0, 2.0 ] );
var it = arr.values();
var v = it.next().value;
v = it.next().value;
var bool = it.next().done;