npmpackage.info

Gathering detailed insights and metrics for @stdlib/math-iter-ops-subtract

@stdlib/math-iter-ops-subtract - 0.2.2 | npmpackage.info

@stdlib/math-iter-ops-subtract

Create an iterator which performs element-wise subtraction of two or more iterators.

0.2.2

Apache-2.0

JavaScript

41.98 kB

4.2

Installations

npm install @stdlib/math-iter-ops-subtract

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

stdlib-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

1 Stars

64 Commits

3 Watchers

5 Branches

14 Contributors

Updated on Dec 30, 2024

Sponsor this package

https://opencollective.com/stdlib

Maintainers

View All 14 Contributors

Package Meta Information

Latest Version

0.2.2

Package Id

@stdlib/math-iter-ops-subtract@0.2.2

Unpacked Size

41.98 kB

Size

10.88 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Jul 27, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/assert-is-function @stdlib/assert-is-iterator-like @stdlib/assert-is-number @stdlib/string-format @stdlib/symbol-iterator @stdlib/utils-define-nonenumerable-read-only-property @stdlib/error-tools-fmtprodmsg

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!

iterSubtract

$NPM version$ $Build Status$ $Coverage Status$

Create an iterator which performs element-wise subtraction of two or more iterators.

Installation

1npm install @stdlib/math-iter-ops-subtract

Usage

1var iterSubtract = require( '@stdlib/math-iter-ops-subtract' );

iterSubtract( iter0, ...iterator )

Returns an iterator which performs element-wise subtraction of two or more iterators.

1var array2iterator = require( '@stdlib/array-to-iterator' );
2
3var it1 = array2iterator( [ 1.0, 5.0 ] );
4var it2 = array2iterator( [ 3.0, 4.0 ] );
5
6var it = iterSubtract( it1, it2 );
7// returns <Object>
8
9var v = it.next().value;
10// returns -2.0
11
12v = it.next().value;
13// returns 1.0
14
15var bool = it.next().done;
16// returns true

The 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 value property and a done property having a boolean value 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.

1var array2iterator = require( '@stdlib/array-to-iterator' );
2
3var arr = array2iterator( [ 1.0, 2.0 ] );
4
5var it = iterSubtract( arr, 4.0 );
6// returns <Object>
7
8var v = it.next().value;
9// returns -3.0
10
11v = it.next().value;
12// returns -2.0
13
14var bool = it.next().done;
15// returns true

Notes

If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which 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.iterator and provided iterators are iterable, the returned iterator is iterable.

Examples

1var iterSineWave = require( '@stdlib/simulate-iter-sine-wave' );
2var iterSubtract = require( '@stdlib/math-iter-ops-subtract' );
3
4// Create an iterator which generates a sine wave:
5var sine1 = iterSineWave({
6    'period': 50,
7    'offset': 0,
8    'iter': 100
9});
10
11// Create another iterator which generates a higher frequency sine wave:
12var sine2 = iterSineWave({
13    'period': 10,
14    'offset': 0,
15    'iter': 100
16});
17
18// Create an iterator which subtracts the two waveforms:
19var it = iterSubtract( sine1, sine2 );
20
21// Perform manual iteration...
22var v;
23while ( true ) {
24    v = it.next();
25    if ( v.done ) {
26        break;
27    }
28    console.log( v.value );
29}

Notice

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.

Community

License

See LICENSE.

Copyright

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/math-iter-ops-subtract/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/math-iter-ops-subtract/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/math-iter-ops-subtract/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/math-iter-ops-subtract/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/math-iter-ops-subtract/productionize.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83
Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93
Info: 33 out of 33 GitHub-owned GitHubAction dependencies pinned
Info: 19 out of 24 third-party GitHubAction dependencies pinned
Info: 0 out of 32 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@stdlib/math-iter-ops-subtract

Installations

Developer Guide

Yes

CommonJS

>=0.10.0

16.20.2

8.19.4

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

iterSubtract

Installation

Usage

iterSubtract( iter0, ...iterator )

Notes

Examples

See Also

Notice

Community

License

Copyright

10

10

10

10

9

3

0

0

0

0

0

0

0

4.2

/10