https://github.com/stdlib-js/math-iter-ops-divide
Create an iterator which performs element-wise division of two or more iterators.
https://github.com/stdlib-js/math-iter-ops-divide
arithmetic div divide division iterable iterate iterator javascript math mathematics multiplication multiply node node-js nodejs prod product stdlib
Last synced: 7 months ago
JSON representation
Create an iterator which performs element-wise division of two or more iterators.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-iter-ops-divide
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T17:02:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T02:21:10.000Z (over 1 year ago)
- Last Synced: 2024-05-01T11:59:58.326Z (over 1 year ago)
- Topics: arithmetic, div, divide, division, iterable, iterate, iterator, javascript, math, mathematics, multiplication, multiply, node, node-js, nodejs, prod, product, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 755 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# iterDivide
[![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 division of two or more [iterators][mdn-iterator-protocol].
## Installation
```bash
npm install @stdlib/math-iter-ops-divide
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] 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.
## Usage
```javascript
var iterDivide = require( '@stdlib/math-iter-ops-divide' );
```
#### iterDivide( iter0, ...iterator )
Returns an [iterator][mdn-iterator-protocol] which performs element-wise division 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 = iterDivide( it1, it2 );
// returns
var v = it.next().value;
// returns 3.0
v = it.next().value;
// returns 0.5
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 = iterDivide( arr, 4.0 );
// returns
var v = it.next().value;
// returns 0.25
v = it.next().value;
// returns 0.5
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 iterSineWave = require( '@stdlib/simulate-iter-sine-wave' );
var iterDivide = require( '@stdlib/math-iter-ops-divide' );
// Create an iterator which generates a sine wave:
var sine = iterSineWave({
'period': 50,
'offset': 0,
'iter': 100
});
// Create an iterator which scales the sine wave amplitude:
var it = iterDivide( sine, 10.0 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
```
* * *
## See Also
- [`@stdlib/math-iter/ops/add`][@stdlib/math/iter/ops/add]: create an iterator which performs element-wise addition of two or more iterators.
- [`@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.
* * *
## Notice
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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-iter-ops-divide.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-iter-ops-divide
[test-image]: https://github.com/stdlib-js/math-iter-ops-divide/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-iter-ops-divide/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-iter-ops-divide/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-iter-ops-divide?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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-divide/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-iter-ops-divide/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-iter-ops-divide/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-iter-ops-divide/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-iter-ops-divide/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-iter-ops-divide/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-iter-ops-divide/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-iter-ops-divide/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/math/iter/ops/add]: https://github.com/stdlib-js/math-iter-ops-add
[@stdlib/math/iter/ops/divide]: https://github.com/stdlib-js/math-iter-ops-divide
[@stdlib/math/iter/ops/multiply]: https://github.com/stdlib-js/math-iter-ops-multiply