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 on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Create an iterator from a sparse array-like object.
npm install @stdlib/array-to-sparse-iteratorAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README).
The branches.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.
var sparsearray2iterator = require( '@stdlib/array-to-sparse-iterator' );Returns an iterator which iterates over each element in a sparse array-like object.
var it = sparsearray2iterator( [ 1, , , 4 ] );
// returns <Object>
var v = it.next().value;
// returns 1
v = it.next().value;
// returns 4
var bool = it.next().done;
// returns trueThe returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a
valueproperty and adoneproperty having abooleanvalue indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
To invoke a function for each src value, provide a callback function.
function fcn( v ) {
return v * 10.0;
}
var it = sparsearray2iterator( [ 1, , 3, 4 ], fcn );
// returns <Object>
var v = it.next().value;
// returns 10.0
v = it.next().value;
// returns 30.0
// ...The invoked function is provided three arguments:
- value: iterated value.
- index: iterated value index.
- src: source array-like object.
function fcn( v, i ) {
return v * (i+1);
}
var it = sparsearray2iterator( [ 1, 2, , 4 ], fcn );
// returns <Object>
var v = it.next().value;
// returns 1
v = it.next().value;
// returns 4
v = it.next().value;
// returns 16To set the callback function execution context, provide a thisArg.
function fcn( v ) {
this.count += 1;
return v * 10.0;
}
var ctx = {
'count': 0
};
var it = sparsearray2iterator( [ 1, , 3, 4 ], fcn, ctx );
// returns <Object>
var v = it.next().value;
// returns 10.0
v = it.next().value;
// returns 30.0
var count = ctx.count;
// returns 2- If an environment supports
Symbol.iterator, the returned iterator is iterable. - If provided a generic
array, the returned iterator ignores holes (i.e.,undefinedvalues). To iterate over all genericarrayelements, use@stdlib/array-to-iterator. - A returned iterator does not copy a provided array-like
object. To ensure iterable reproducibility, copy a provided array-likeobjectbefore creating an iterator. Otherwise, any changes to the contents of an array-likeobjectwill be reflected in the returned iterator. - In environments supporting
Symbol.iterator, the function explicitly does not invoke an array's@@iteratormethod, regardless of whether this method is defined. To convert an array to an implementation defined iterator, invoke this method directly. - The returned iterator supports array-like objects having getter and setter accessors for array element access (e.g.,
@stdlib/array-complex64).
var Float64Array = require( '@stdlib/array-float64' );
var inmap = require( '@stdlib/utils-inmap' );
var randu = require( '@stdlib/random-base-randu' );
var sparsearray2iterator = require( '@stdlib/array-to-sparse-iterator' );
function scale( v, i ) {
return v * (i+1);
}
// Create an array partially filled with random numbers:
var arr = new Array( 100 );
var i;
for ( i = 0; i < arr.length; i += 2 ) {
arr[ i ] = randu();
}
// Create an iterator from the array which scales iterated values:
var it = sparsearray2iterator( arr, scale );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}@stdlib/array-from-iterator: create (or fill) an array from an iterator.@stdlib/array-to-iterator: create an iterator from an array-like object.@stdlib/array-to-sparse-iterator-right: create an iterator from a sparse array-like object, iterating from right to left.
This package is part of stdlib, 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 develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
