Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork0
stdlib-js/array-float32
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out onGitHub, and please considerfinancially supporting stdlib. We greatly appreciate your continued support!
Typed array constructor which returns atyped array representing an array of single-precision floating-point numbers in the platform byte order.
npm install @stdlib/array-float32
Alternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use theES Module available on theesmbranch (seeREADME). - If you are using Deno, visit the
denobranch (seeREADME for usage intructions). - For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on the
umdbranch (seeREADME).
Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
varFloat32Array=require('@stdlib/array-float32');
Atyped array constructor which returns atyped array representing an array of single-precision floating-point numbers in the platform byte order.
vararr=newFloat32Array();// returns <Float32Array>
Returns atyped array having a specified length.
vararr=newFloat32Array(5);// returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]
Creates atyped array from anothertyped array.
varFloat64Array=require('@stdlib/array-float64');vararr1=newFloat64Array([0.5,0.5,0.5]);vararr2=newFloat32Array(arr1);// returns <Float32Array>[ 0.5, 0.5, 0.5 ]
Creates atyped array from an array-likeobject or iterable.
vararr=newFloat32Array([0.5,0.5,0.5]);// returns <Float32Array>[ 0.5, 0.5, 0.5 ]
Returns atyped array view of anArrayBuffer.
varArrayBuffer=require('@stdlib/array-buffer');varbuf=newArrayBuffer(16);vararr=newFloat32Array(buf,0,4);// returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
Number of bytes per view element.
varnbytes=Float32Array.BYTES_PER_ELEMENT;// returns 4
Typed array constructor name.
varstr=Float32Array.name;// returns 'Float32Array'
Read-only property which returns theArrayBuffer referenced by thetyped array.
vararr=newFloat32Array(5);varbuf=arr.buffer;// returns <ArrayBuffer>
Read-only property which returns the length (in bytes) of thetyped array.
vararr=newFloat32Array(5);varbyteLength=arr.byteLength;// returns 20
Read-only property which returns the offset (in bytes) of thetyped array from the start of itsArrayBuffer.
vararr=newFloat32Array(5);varbyteOffset=arr.byteOffset;// returns 0
Number of bytes per view element.
vararr=newFloat32Array(5);varnbytes=arr.BYTES_PER_ELEMENT;// returns 4
Read-only property which returns the number of view elements.
vararr=newFloat32Array(5);varlen=arr.length;// returns 5
Creates a new typed array from an array-likeobject or an iterable.
vararr=Float32Array.from([1.0,2.0]);// returns <Float32Array>[ 1.0, 2.0 ]
To invoke a function for eachsrc value, provide a callback function.
functionmapFcn(v){returnv*2.0;}vararr=Float32Array.from([1.0,2.0],mapFcn);// returns <Float32Array>[ 2.0, 4.0 ]
A callback function is provided two arguments:
value: source value.index: source index.
To set the callback execution context, provide athisArg.
functionmapFcn(v){this.count+=1;returnv*2.0;}varctx={'count':0};vararr=Float32Array.from([1.0,2.0],mapFcn,ctx);// returns <Float32Array>[ 2.0, 4.0 ]varn=ctx.count;// returns 2
Creates a new typed array from a variable number of arguments.
vararr=Float32Array.of(1.0,2.0);// returns <Float32Array>[ 1.0, 2.0 ]
Copies a sequence of elements within an array starting atstart and ending atend (non-inclusive) to the position starting attarget.
vararr=newFloat32Array([1.0,2.0,3.0,4.0,5.0]);// Copy the last two elements to the first two elements:arr.copyWithin(0,3);varv=arr[0];// returns 4.0v=arr[1];// returns 5.0
By default,end equals the number of array elements (i.e., one more than the last array index). To limit the sequence length, provide anend argument.
vararr=newFloat32Array([1.0,2.0,3.0,4.0,5.0]);// Copy the first two elements to the last two elements:arr.copyWithin(3,0,2);varv=arr[3];// returns 1.0v=arr[4];// returns 2.0
When atarget,start, and/orend 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:
vararr=newFloat32Array([1.0,2.0,3.0,4.0,5.0]);// Copy the first two elements to the last two elements:arr.copyWithin(-2,-5,-3);varv=arr[3];// returns 1.0v=arr[4];// returns 2.0
Returns an iterator for iterating over array key-value pairs.
vararr=newFloat32Array([1.0,2.0]);// Create an iterator:varit=arr.entries();// Iterate over key-value pairs...varv=it.next().value;// returns [ 0, 1.0 ]v=it.next().value;// returns [ 1, 2.0 ]varbool=it.next().done;// returns true
Tests whether all array elements pass a test implemented by apredicate function.
functionpredicate(v){return(v<=1.0);}vararr=newFloat32Array([1.0,2.0]);varbool=arr.every(predicate);// returns false
Apredicate function is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionpredicate(v){this.count+=1;return(v>=1.0);}varctx={'count':0};vararr=newFloat32Array([1.0,2.0]);varbool=arr.every(predicate,ctx);// returns truevarn=ctx.count;// returns 2
Fills an array from astart index to anend index (non-inclusive) with a providedvalue.
vararr=newFloat32Array(2);// Set all array elements to the same value:arr.fill(2.0);varv=arr[0];// returns 2.0v=arr[1];// returns 2.0// Set all array elements starting from the first index to the same value:arr.fill(3.0,1);v=arr[0];// returns 2.0v=arr[1];// returns 3.0// Set all array elements, except the last element, to the same value:arr.fill(4.0,0,arr.length-1);v=arr[0];// returns 4.0v=arr[1];// returns 3.0
When astart and/orend index is negative, the respective index is determined relative to the last array element.
vararr=newFloat32Array(2);// Set all array elements, except the last element, to the same value:arr.fill(2.0,-arr.length,-1);varv=arr[0];// returns 2.0v=arr[1];// returns 0.0
Creates a new array (of the same data type as the host array) which includes those elements for which apredicate function returns a truthy value.
functionpredicate(v){return(v>=2.0);}vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.filter(predicate);// returns <Float32Array>[ 2.0, 3.0 ]
If apredicate function does not return a truthy value for any array element, the method returns an empty array.
functionpredicate(v){return(v>=10.0);}vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.filter(predicate);// returns <Float32Array>[]
Apredicate function is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionpredicate(v){this.count+=1;return(v>=2.0);}varctx={'count':0};vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.filter(predicate,ctx);varn=ctx.count;// returns 3
Returns the first array element for which a providedpredicate function returns a truthy value.
functionpredicate(v){return(v>2.0);}vararr=newFloat32Array([1.0,2.0,3.0]);varv=arr.find(predicate);// returns 3.0
If apredicate function does not return a truthy value for any array element, the method returnsundefined.
functionpredicate(v){return(v<1.0);}vararr=newFloat32Array([1.0,2.0,3.0]);varv=arr.find(predicate);// returns undefined
Apredicate function is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionpredicate(v){this.count+=1;return(v>2.0);}varctx={'count':0};vararr=newFloat32Array([1.0,2.0,3.0]);varv=arr.find(predicate,ctx);// returns 3.0varn=ctx.count;// returns 3
Returns the index of the first array element for which a providedpredicate function returns a truthy value.
functionpredicate(v){return(v>=3.0);}vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.findIndex(predicate);// returns 2
If apredicate function does not return a truthy value for any array element, the method returns-1.
functionpredicate(v){return(v<1.0);}vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.findIndex(predicate);// returns -1
Apredicate function is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionpredicate(v){this.count+=1;return(v>=3.0);}varctx={'count':0};vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.findIndex(predicate,ctx);// returns 2varn=ctx.count;// returns 3
Invokes a callback for each array element.
vararr=newFloat32Array([1.0,2.0,3.0]);varstr='';functionfcn(v,i){str+=i+':'+v;if(i<arr.length-1){str+=' ';}}arr.forEach(fcn);console.log(str);// => '0:1 1:2 2:3'
The callback is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionfcn(){this.count+=1;}varctx={'count':0};vararr=newFloat32Array([1.0,2.0,3.0]);arr.forEach(fcn,ctx);varn=ctx.count;// returns 3
Returns aboolean indicating whether an array includes a search element.
vararr=newFloat32Array([1.0,2.0,3.0]);varbool=arr.includes(3.0);// returns truebool=arr.includes(0.0);// returns false
By default, the method searches the entire array (fromIndex = 0). To begin searching from a specific array index, provide afromIndex.
vararr=newFloat32Array([1.0,2.0,3.0]);varbool=arr.includes(1.0,1);// returns false
When afromIndex is negative, the starting index is resolved relative to the last array element.
vararr=newFloat32Array([1.0,2.0,3.0]);varbool=arr.includes(1.0,-2);// returns false
The method doesnot distinguish between signed and unsigned zero.
Returns the index of the first array element strictly equal to a search element.
vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.indexOf(3.0);// returns 2idx=arr.indexOf(0.0);// returns -1
By default, the method searches the entire array (fromIndex = 0). To begin searching from a specific array index, provide afromIndex.
vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.indexOf(1.0,1);// returns -1
When afromIndex is negative, the starting index is resolved relative to the last array element.
vararr=newFloat32Array([1.0,2.0,3.0]);varidx=arr.indexOf(1.0,-2);// returns -1
The method doesnot distinguish between signed and unsigned zero.
Serializes an array by joining all array elements as a string.
vararr=newFloat32Array([1.0,2.0,3.0]);varstr=arr.join();// returns '1,2,3'
By default, the method delineates array elements using a comma,. To specify a custom separator, provide aseparator string.
vararr=newFloat32Array([1.0,2.0,3.0]);varstr=arr.join('|');// returns '1|2|3'
Returns an iterator for iterating over array keys.
vararr=newFloat32Array([1.0,2.0]);// Create an iterator:varit=arr.keys();// Iterate over keys...varv=it.next().value;// returns 0v=it.next().value;// returns 1varbool=it.next().done;// returns true
Returns the index of the last array element strictly equal to a search element, iterating from right to left.
vararr=newFloat32Array([1.0,0.0,2.0,0.0,1.0]);varidx=arr.lastIndexOf(0.0);// returns 3idx=arr.lastIndexOf(3.0);// returns -1
By default, the method searches the entire array (fromIndex = -1). To begin searching from a specific array index, provide afromIndex.
vararr=newFloat32Array([1.0,0.0,2.0,0.0,1.0]);varidx=arr.lastIndexOf(0.0,2);// returns 1
When afromIndex is negative, the starting index is resolved relative to the last array element.
vararr=newFloat32Array([1.0,0.0,2.0,0.0,1.0]);varidx=arr.lastIndexOf(0.0,-3);// returns 1
The method doesnot distinguish between signed and unsigned zero.
Maps each array element to an element in a new array having the same data type as the host array.
functionfcn(v){returnv*2.0;}vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.map(fcn);// returns <Float32Array>[ 2.0, 4.0, 6.0 ]
A callback is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionfcn(v){this.count+=1;returnv*2.0;}varctx={'count':0};vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.map(fcn,ctx);varn=ctx.count;// returns 3
Applies a function against an accumulator and each element in an array and returns the accumulated result.
functionfcn(acc,v){returnacc+(v*v);}vararr=newFloat32Array([2.0,1.0,3.0]);varv=arr.reduce(fcn);// returns 12.0
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.
functionfcn(acc,v){returnacc+(v*v);}vararr=newFloat32Array([2.0,1.0,3.0]);varv=arr.reduce(fcn,0.0);// returns 14.0
A callback is provided four arguments:
acc: accumulated result.value: array element.index: array index.arr: array on which the method is invoked.
Applies a function against an accumulator and each element in an array and returns the accumulated result, iterating from right to left.
functionfcn(acc,v){returnacc+(v*v);}vararr=newFloat32Array([2.0,1.0,3.0]);varv=arr.reduceRight(fcn);// returns 8.0
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.
functionfcn(acc,v){returnacc+(v*v);}vararr=newFloat32Array([2.0,1.0,3.0]);varv=arr.reduce(fcn,0.0);// returns 14.0
A callback is provided four arguments:
acc: accumulated result.value: array element.index: array index.arr: array on which the method is invoked.
Reverses an arrayin-place (thus mutating the array on which the method is invoked).
vararr=newFloat32Array([2.0,0.0,3.0]);// Reverse the array:arr.reverse();varv=arr[0];// returns 3.0v=arr[1];// returns 0.0v=arr[2];// returns 2.0
Sets array elements.
vararr=newFloat32Array([1.0,2.0,3.0]);// returns <Float32Array>[ 1.0, 2.0, 3.0 ]// Set the first two array elements:arr.set([4.0,5.0]);varv=arr[0];// returns 4.0v=arr[1];// returns 5.0
By default, the method starts writing values at the first array index. To specify an alternative index, provide an indexoffset.
vararr=newFloat32Array([1.0,2.0,3.0]);// returns <Float32Array>[ 1.0, 2.0, 3.0 ]// Set the last two array elements:arr.set([4.0,5.0],1);varv=arr[1];// returns 4.0v=arr[2];// returns 5.0
Copies array elements to a new array with the same underlying data type as the host array.
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.slice();varbool=(arr1===arr2);// returns falsebool=(arr1.buffer===arr2.buffer);// returns falsevarv=arr2[0];// returns 1.0v=arr2[1];// returns 2.0v=arr2[2];// returns 3.0
By default, the method copies elements beginning with the first array element. To specify an alternative array index at which to begin copying, provide abegin index (inclusive).
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.slice(1);varlen=arr2.length;// returns 2varv=arr2[0];// returns 2.0v=arr2[1];// returns 3.0
By default, the method copies all array elements afterbegin. To specify an alternative array index at which to end copying, provide anend index (exclusive).
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.slice(0,2);varlen=arr2.length;// returns 2varv=arr2[0];// returns 1.0v=arr2[1];// returns 2.0
When abegin and/orend index is negative, the respective index is determined relative to the last array element.
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.slice(-arr1.length,-1);varlen=arr2.length;// returns 2varv=arr2[0];// returns 1.0v=arr2[1];// returns 2.0
Tests whether at least one array element passes a test implemented by apredicate function.
functionpredicate(v){return(v>=2.0);}vararr=newFloat32Array([1.0,2.0]);varbool=arr.some(predicate);// returns true
Apredicate function is provided three arguments:
value: array element.index: array index.arr: array on which the method is invoked.
To set the callback execution context, provide athisArg.
functionpredicate(v){this.count+=1;return(v>=2.0);}varctx={'count':0};vararr=newFloat32Array([1.0,1.0]);varbool=arr.some(predicate,ctx);// returns falsevarn=ctx.count;// returns 2
Sorts an arrayin-place (thus mutating the array on which the method is invoked).
vararr=newFloat32Array([2.0,3.0,0.0]);// Sort the array (in ascending order):arr.sort();varv=arr[0];// returns 0.0v=arr[1];// returns 2.0v=arr[2];// returns 3.0
By default, the method sorts array elements in ascending order. To impose a custom order, provide acompareFunction.
functiondescending(a,b){returnb-a;}vararr=newFloat32Array([2.0,3.0,0.0]);// Sort the array (in descending order):arr.sort(descending);varv=arr[0];// returns 3.0v=arr[1];// returns 2.0v=arr[2];// returns 0.0
The comparison function is provided two array elements,a andb, per invocation, and its return value determines the sort order as follows:
- If the comparison function returns a valueless than zero, then the method sorts
ato an index lower thanb(i.e.,ashould comebeforeb). - If the comparison function returns a valuegreater than zero, then the method sorts
ato an index higher thanb(i.e.,bshould comebeforea). - If the comparison function returnszero, then the relative order of
aandbshould remain unchanged.
Creates a new typed array view over the same underlyingArrayBuffer and with the same underlying data type as the host array.
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.subarray();// returns <Float32Array>[ 1.0, 2.0, 3.0 ]varbool=(arr1.buffer===arr2.buffer);// returns true
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 abegin index (inclusive).
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.subarray(1);// returns <Float32Array>[ 2.0, 3.0 ]varbool=(arr1.buffer===arr2.buffer);// returns true
By default, the method creates a typed array view which includes all array elements afterbegin. To limit the number of array elements afterbegin, provide anend index (exclusive).
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.subarray(0,2);// returns <Float32Array>[ 1.0, 2.0 ]varbool=(arr1.buffer===arr2.buffer);// returns true
When abegin and/orend index is negative, the respective index is determined relative to the last array element.
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.subarray(-arr1.length,-1);// returns <Float32Array>[ 1.0, 2.0 ]varbool=(arr1.buffer===arr2.buffer);// returns true
If the method is unable to resolve indices to a non-empty array subsequence, the method returns an empty typed array.
vararr1=newFloat32Array([1.0,2.0,3.0]);vararr2=arr1.subarray(10,-1);// returns <Float32Array>[]
Serializes an array as a locale-specificstring.
vararr=newFloat32Array([1.0,2.0,3.0]);varstr=arr.toLocaleString();// returns '1,2,3'
Serializes an array as astring.
vararr=newFloat32Array([1.0,2.0,3.0]);varstr=arr.toString();// returns '1,2,3'
Returns an iterator for iterating over array elements.
vararr=newFloat32Array([1.0,2.0]);// Create an iterator:varit=arr.values();// Iterate over array elements...varv=it.next().value;// returns 1.0v=it.next().value;// returns 2.0varbool=it.next().done;// returns true
varrandu=require('@stdlib/random-base-randu');varctor=require('@stdlib/array-float32');vararr;vari;arr=newctor(10);for(i=0;i<arr.length;i++){arr[i]=randu()*100.0;}console.log(arr);
@stdlib/array-buffer:ArrayBuffer.@stdlib/array-float64:Float64Array.@stdlib/array-int16:Int16Array.@stdlib/array-int32:Int32Array.@stdlib/array-int8:Int8Array.@stdlib/array-uint16:Uint16Array.@stdlib/array-uint32:Uint32Array.@stdlib/array-uint8:Uint8Array.@stdlib/array-uint8c:Uint8ClampedArray.
This package is part ofstdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to developstdlib, see the main projectrepository.
SeeLICENSE.
Copyright © 2016-2025. The StdlibAuthors.
About
Float32Array.
Topics
Resources
License
Code of conduct
Contributing
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Packages0
Uh oh!
There was an error while loading.Please reload this page.