ndarray-iter-values

Create an iterator which returns individual elements from a provided ndarray.

https://github.com/stdlib-js/ndarray-iter-values

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.6%) to scientific vocabulary

Keywords

entries index indices iter iterate iteration iterator javascript matrix multidimensional ndarray node node-js nodejs stdlib tensor util utilities utility utils

Last synced: 6 months ago · JSON representation ·

Repository

Create an iterator which returns individual elements from a provided ndarray.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 935 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

entries index indices iter iterate iteration iterator javascript matrix multidimensional ndarray node node-js nodejs stdlib tensor util utilities utility utils

Created over 2 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

nditerValues

Create an iterator which returns individual elements from a provided ndarray.

## Installation ```bash npm install @stdlib/ndarray-iter-values ``` 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 nditerValues = require( '@stdlib/ndarray-iter-values' ); ``` #### nditerValues( x\[, options] ) Returns an iterator which returns individual elements from a provided [`ndarray`][@stdlib/ndarray/ctor]. ```javascript var array = require( '@stdlib/ndarray-array' ); var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] ); // returns var iter = nditerValues( x ); var v = iter.next().value; // returns 1 v = iter.next().value; // returns 2 v = iter.next().value; // returns 3 // ... ``` The function accepts the following `options`: - **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`. By default, the iterator iterates according to the layout order of the input [`ndarray`][@stdlib/ndarray/ctor]. To iterate according to a specified order, set the `order` option. ```javascript var array = require( '@stdlib/ndarray-array' ); var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ], { 'order': 'row-major' }); // returns var iter = nditerValues( x, { 'order': 'column-major' }); var v = iter.next().value; // returns 1 v = iter.next().value; // returns 5 v = iter.next().value; // returns 3 // ... ``` 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.

## Notes - If an environment supports `Symbol.iterator`, the returned iterator is iterable. - A returned iterator does **not** copy a provided [`ndarray`][@stdlib/ndarray/ctor]. To ensure iterable reproducibility, copy the input [`ndarray`][@stdlib/ndarray/ctor] **before** creating an iterator. Otherwise, any changes to the contents of input [`ndarray`][@stdlib/ndarray/ctor] will be reflected in the returned iterator. - In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an ndarray's `@@iterator` method, regardless of whether this method is defined.

## Examples ```javascript var array = require( '@stdlib/ndarray-array' ); var zeroTo = require( '@stdlib/array-base-zero-to' ); var nditerValues = require( '@stdlib/ndarray-iter-values' ); // Define an input array: var x = array( zeroTo( 27 ), { 'shape': [ 3, 3, 3 ] }); // Create an iterator for returning individual elements: var it = nditerValues( x ); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( v.value ); } ```

* * * ## 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].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 33

Last Year

Push event: 33

Committers

Last synced: 8 months ago

All Time

Total Commits: 24
Total Committers: 1
Avg Commits per committer: 24.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 11
Committers: 1
Avg Commits per committer: 11.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	24

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
actions/upload-artifact a8a3f3ad30e3422c9c7b888a15615d19a852ae32 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish fe72237be0920f7a0cafd6a966c9b929c9466e9b composite
act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 composite

.github/workflows/test.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/test_bundles.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
denoland/setup-deno 61fe2df320078202e33d7d5ad347e7dcfa0e8f31 composite

.github/workflows/test_coverage.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
codecov/codecov-action eaaf4bedf32dbdc6b720b63067d99c4d77d6047d composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

package.json npm

@stdlib/array-base-zero-to ^0.1.0 development
@stdlib/assert-is-iterator-like ^0.1.1 development
@stdlib/assert-is-number ^0.1.1 development
@stdlib/bench ^0.2.0 development
@stdlib/ndarray-array ^0.1.0 development
@stdlib/ndarray-zeros ^0.1.0 development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-zeros ^0.1.1
@stdlib/assert-has-own-property ^0.1.1
@stdlib/assert-is-ndarray-like ^0.1.0
@stdlib/assert-is-plain-object ^0.1.1
@stdlib/ndarray-base-assert-is-order ^0.1.1
@stdlib/ndarray-base-next-cartesian-index ^0.1.0
@stdlib/ndarray-base-numel ^0.1.1
@stdlib/ndarray-shape ^0.1.0
@stdlib/string-format ^0.1.1
@stdlib/symbol-iterator ^0.1.1
@stdlib/types ^0.2.0
@stdlib/utils-define-nonenumerable-read-only-property ^0.1.1

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-iter-values

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

nditerValues

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies