Create an iterator which performs element-wise addition of two or more iterators.
npm install @stdlib/math-iter-ops-addWe 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!
About stdlib...
[![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 addition of two or more [iterators][mdn-iterator-protocol].
``bash`
npm install @stdlib/math-iter-ops-add
`javascript`
var iterAdd = require( '@stdlib/math-iter-ops-add' );
#### iterAdd( iter0, ...iterator )
Returns an [iterator][mdn-iterator-protocol] which performs element-wise addition of two or more [iterators][mdn-iterator-protocol].
`javascript
var array2iterator = require( '@stdlib/array-to-iterator' );
var it1 = array2iterator( [ 1.0, 2.0 ] );
var it2 = array2iterator( [ 3.0, 4.0 ] );
var it = iterAdd( it1, it2 );
// returns
var v = it.next().value;
// returns 4.0
v = it.next().value;
// returns 6.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, 2.0 ] );
var it = iterAdd( arr, 3.14 );
// returns
var v = it.next().value;
// returns 4.14
v = it.next().value;
// returns 5.14
var bool = it.next().done;
// returns true
`
- 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.Symbol.iterator
- 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 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 iterAdd = require( '@stdlib/math-iter-ops-add' );
// 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 adds the two waveforms:
var it = iterAdd( sine1, sine2 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
`
*
- [@stdlib/math-iter/ops/divide][@stdlib/math/iter/ops/divide]: create an iterator which performs element-wise division of two or more iterators.
- [@stdlib/math-iter/ops/multiply][@stdlib/math/iter/ops/multiply]: create an iterator which performs element-wise multiplication of two or more iterators.
- [@stdlib/math-iter/ops/subtract][@stdlib/math/iter/ops/subtract]: create an iterator which performs element-wise subtraction of two or more iterators.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-iter-ops-add.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-iter-ops-add
[test-image]: https://github.com/stdlib-js/math-iter-ops-add/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/math-iter-ops-add/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-iter-ops-add/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-iter-ops-add?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-iter-ops-add/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-iter-ops-add/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-iter-ops-add/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-iter-ops-add/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-iter-ops-add/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-iter-ops-add/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-iter-ops-add/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-iter-ops-add/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/math/iter/ops/divide]: https://www.npmjs.com/package/@stdlib/math-iter-ops-divide
[@stdlib/math/iter/ops/multiply]: https://www.npmjs.com/package/@stdlib/math-iter-ops-multiply
[@stdlib/math/iter/ops/subtract]: https://www.npmjs.com/package/@stdlib/math-iter-ops-subtract