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 which steps by a specified amount.
npm install @stdlib/iter-stridedAlternatively,
- 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 iterStrided = require( '@stdlib/iter-strided' );Returns an iterator which steps by a specified amount.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1, 2, 3, 4, 5, 6, 7, 8 ] );
var it = iterStrided( arr, 2 );
// returns <Object>
var r = it.next().value;
// returns 1
r = it.next().value;
// returns 3
r = it.next().value;
// returns 5
// ...The 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 skip the first N values of a provided iterator, provide an offset argument.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1, 2, 3, 4, 5, 6, 7, 8 ] );
var it = iterStrided( arr, 2, 1 );
// returns <Object>
var r = it.next().value;
// returns 2
r = it.next().value;
// returns 4
r = it.next().value;
// returns 6
// ...By default, the returned iterator defers consuming the first N input iterator values until the first value of the returned iterator is consumed. To eagerly advance the input iterator, set the eager argument to true.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1, 2, 3, 4, 5, 6, 7, 8 ] );
var it = iterStrided( arr, 1, 4, true );
// returns <Object>
var r = it.next().value;
// returns 5
r = it.next().value;
// returns 6
r = it.next().value;
// returns 7
// ...var randu = require( '@stdlib/random-iter-randu' );
var iterStrided = require( '@stdlib/iter-strided' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = randu({
'seed': 1234,
'iter': 10
});
// Create an iterator which returns every other random number:
var it = iterStrided( rand, 2 );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}@stdlib/iter-advance: advance an iterator.@stdlib/iter-nth: return the nth iterated value.@stdlib/iter-strided-by: create an iterator which steps according to a provided callback function.
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.