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 performs an element-wise modulo operation of two or more iterators.
npm install @stdlib/math-iter-ops-modAlternatively,
- 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 iterMod = require( '@stdlib/math-iter-ops-mod' );Returns an iterator which performs an element-wise modulo operation of two or more iterators.
var array2iterator = require( '@stdlib/array-to-iterator' );
var it1 = array2iterator( [ 3.0, -2.0 ] );
var it2 = array2iterator( [ 1.0, 4.0 ] );
var it = iterMod( it1, it2 );
// returns <Object>
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns -2.0
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.
If provided a numeric value as an iterator argument, the value is broadcast as an infinite iterator which always returns the provided value.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1.0, 7.0 ] );
var it = iterMod( arr, 4.0 );
// returns <Object>
var v = it.next().value;
// returns 1.0
v = it.next().value;
// returns 3.0
var bool = it.next().done;
// returns true- If an iterated value is non-numeric (including
NaN), the returned iterator returnsNaN. If non-numeric iterated values are possible, you are advised to provide aniteratorwhich type checks and handles non-numeric values accordingly. - The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once one of the provided iterators ends.
- If an environment supports
Symbol.iteratorand provided iterators are iterable, the returned iterator is iterable.
var iterDiscreteUniform = require( '@stdlib/random-iter-discrete-uniform' );
var iterMod = require( '@stdlib/math-iter-ops-mod' );
// Create an iterator which generates pseudorandom integers:
var rand = iterDiscreteUniform( 0, 100, {
'iter': 100
});
// Create an iterator which performs an element-wise modulo operation:
var it = iterMod( rand, 10 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}@stdlib/math-iter/ops/divide: create an iterator which performs element-wise division of two or more iterators.
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.
