# iterMod > Create an [iterator][mdn-iterator-protocol] which performs an element-wise modulo operation of two or more [iterators][mdn-iterator-protocol].
## Usage ```javascript var iterMod = require( '@stdlib/math/iter/ops/mod' ); ``` #### iterMod( iter0, ...iterator ) Returns an [iterator][mdn-iterator-protocol] which performs an element-wise modulo operation of two or more [iterators][mdn-iterator-protocol]. ```javascript 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 var v = it.next().value; // returns 0.0 v = it.next().value; // returns -2.0 var bool = it.next().done; // returns true ``` The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties: - **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished. - **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object. If provided a numeric value as an [`iterator`][mdn-iterator-protocol] argument, the value is broadcast as an **infinite** [iterator][mdn-iterator-protocol] which **always** returns the provided value. ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); var arr = array2iterator( [ 1.0, 7.0 ] ); var it = iterMod( arr, 4.0 ); // returns var v = it.next().value; // returns 1.0 v = it.next().value; // returns 3.0 var bool = it.next().done; // returns true ```
## Notes - If an iterated value is non-numeric (including `NaN`), the returned [iterator][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly. - The length of the returned [iterator][mdn-iterator-protocol] is equal to the length of the shortest provided [iterator][mdn-iterator-protocol]. In other words, the returned [iterator][mdn-iterator-protocol] ends once **one** of the provided [iterators][mdn-iterator-protocol] ends. - If an environment supports `Symbol.iterator` **and** provided [iterators][mdn-iterator-protocol] are iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
## Examples ```javascript 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 ); } ```