Create an iterator from a sparse array-like object, iterating from right to left.
APACHE-2.0 License
Create an iterator from a sparse array-like object, iterating from right to left.
npm install @stdlib/array-to-sparse-iterator-right
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (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 sparsearray2iteratorRight = require( '@stdlib/array-to-sparse-iterator-right' );
Returns an iterator which iterates from right to left over each element in a sparse array-like object
.
var it = sparsearray2iteratorRight( [ 1, , , 4 ] );
// returns <Object>
var v = it.next().value;
// returns 4
v = it.next().value;
// returns 1
var bool = it.next().done;
// returns true
The returned iterator protocol-compliant object has the following properties:
value
property and a done
property having a boolean
value indicating whether the iterator is finished.To invoke a function for each src
value, provide a callback function.
function fcn( v ) {
return v * 10.0;
}
var it = sparsearray2iteratorRight( [ 1, 2, , 4 ], fcn );
// returns <Object>
var v = it.next().value;
// returns 40.0
v = it.next().value;
// returns 20.0
// ...
The invoked function is provided three arguments:
function fcn( v, i ) {
return v * (i+1);
}
var it = sparsearray2iteratorRight( [ 1, 2, , 4 ], fcn );
// returns <Object>
var v = it.next().value;
// returns 16
v = it.next().value;
// returns 4
v = it.next().value;
// returns 1
To 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 = sparsearray2iteratorRight( [ 1, 2, , 4 ], fcn, ctx );
// returns <Object>
var v = it.next().value;
// returns 40.0
v = it.next().value;
// returns 20.0
var count = ctx.count;
// returns 2
Symbol.iterator
, the returned iterator is iterable.array
, the returned iterator ignores holes (i.e., undefined
values). To iterate over all generic array
elements, use @stdlib/array-to-iterator-right
.object
. To ensure iterable reproducibility, copy a provided array-like object
before creating an iterator. Otherwise, any changes to the contents of an array-like object
will be reflected in the returned iterator.Symbol.iterator
, the function explicitly does not invoke an array's @@iterator
method, regardless of whether this method is defined. To convert an array to an implementation defined iterator, invoke this method directly.@stdlib/array-complex64
).var Float64Array = require( '@stdlib/array-float64' );
var inmap = require( '@stdlib/utils-inmap' );
var randu = require( '@stdlib/random-base-randu' );
var sparsearray2iteratorRight = require( '@stdlib/array-to-sparse-iterator-right' );
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 = sparsearray2iteratorRight( 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-right
: create an iterator from an array-like object, iterating from right to left.
@stdlib/array-to-sparse-iterator
: create an iterator from a sparse array-like object.
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.