Create an iterator which performs element-wise subtraction of two or more iterators.
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!
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Create an [iterator][mdn-iterator-protocol] which performs element-wise subtraction of two or more [iterators][mdn-iterator-protocol].
bash
npm install @stdlib/math-iter-ops-subtractscript tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).deno][deno-url] branch (see [README][deno-readme] for usage intructions).umd][umd-url] branch (see [README][umd-readme]).javascript
var iterSubtract = require( '@stdlib/math-iter-ops-subtract' );javascript
var array2iterator = require( '@stdlib/array-to-iterator' );
var it1 = array2iterator( [ 1.0, 5.0 ] );
var it2 = array2iterator( [ 3.0, 4.0 ] );
var it = iterSubtract( it1, it2 );
// returns <Object>
var v = it.next().value;
// returns -2.0
v = it.next().value;
// returns 1.0
var bool = it.next().done;
// returns truevalue property and a done property having a boolean value indicating whether the [iterator][mdn-iterator-protocol] is finished.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, 2.0 ] );
var it = iterSubtract( arr, 4.0 );
// returns <Object>
var v = it.next().value;
// returns -3.0
v = it.next().value;
// returns -2.0
var bool = it.next().done;
// returns trueNaN), 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.Symbol.iterator and provided [iterators][mdn-iterator-protocol] are iterable, the returned [iterator][mdn-iterator-protocol] is iterable.javascript
var iterSineWave = require( '@stdlib/simulate-iter-sine-wave' );
var iterSubtract = require( '@stdlib/math-iter-ops-subtract' );
// Create an iterator which generates a sine wave:
var sine1 = iterSineWave({
'period': 50,
'offset': 0,
'iter': 100
});
// Create another iterator which generates a higher frequency sine wave:
var sine2 = iterSineWave({
'period': 10,
'offset': 0,
'iter': 100
});
// Create an iterator which subtracts the two waveforms:
var it = iterSubtract( sine1, sine2 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
