Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-iter-stacks

Create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.

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

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

iter iterate iteration iterator javascript matrix multidimensional ndarray node node-js nodejs stack stdlib subarray tensor util utilities utility utils
Last synced: 4 months ago · JSON representation ·

Repository

Create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
iter iterate iteration iterator javascript matrix multidimensional ndarray node node-js nodejs stack stdlib subarray tensor util utilities utility utils
Created over 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

nditerStacks

NPM version Build Status Coverage Status <!-- dependencies -->

Create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.

## Installation ```bash npm install @stdlib/ndarray-iter-stacks ``` 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 nditerStacks = require( '@stdlib/ndarray-iter-stacks' ); ``` #### nditerStacks( x, dims\[, options] ) Returns an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions. ```javascript var array = require( '@stdlib/ndarray-array' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] ); // returns var iter = nditerStacks( x, [ 1, 2 ] ); var v = iter.next().value; // returns var arr = ndarray2array( v ); // returns [ [ 1, 2 ], [ 3, 4 ] ] v = iter.next().value; // returns arr = ndarray2array( v ); // returns [ [ 5, 6 ], [ 7, 8 ] ] // ... ``` The function accepts the following `options`: - **readonly**: boolean indicating whether returned [`ndarray`][@stdlib/ndarray/ctor] views should be read-only. In order to return writable [`ndarray`][@stdlib/ndarray/ctor] views, the input [`ndarray`][@stdlib/ndarray/ctor] must be writable. If the input [`ndarray`][@stdlib/ndarray/ctor] is read-only, setting this option to `false` raises an exception. Default: `true`. By default, the iterator returns [`ndarray`][@stdlib/ndarray/ctor] views which are **read-only**. To return writable [views][@stdlib/ndarray/slice], set the `readonly` option to `false`. ```javascript var array = require( '@stdlib/ndarray-array' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] ); // returns var iter = nditerStacks( x, [ 1, 2 ], { 'readonly': false }); var v = iter.next().value; // returns var arr = ndarray2array( v ); // returns [ [ 1, 2 ], [ 3, 4 ] ] v.set( 0, 0, 10 ); arr = ndarray2array( v ); // returns [ [ 10, 2 ], [ 3, 4 ] ] ``` 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 - The input [`ndarray`][@stdlib/ndarray/ctor] must have at least `dims.length+1` dimensions. - The list of provided index dimensions must be unique and resolve to index dimensions sorted in ascending order (i.e., the function does **not** allow rearranging [`ndarray`][@stdlib/ndarray/ctor] dimensions by specifying an arbitrary index order). - 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 ndarray2array = require( '@stdlib/ndarray-to-array' ); var nditerStacks = require( '@stdlib/ndarray-iter-stacks' ); // Define an input array: var x = array( zeroTo( 27 ), { 'shape': [ 3, 3, 3 ] }); // Create an iterator for iterating over matrices: var it = nditerStacks( x, [ 1, 2 ] ); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( ndarray2array( v.value ) ); } // Create an iterator for iterating over matrices: it = nditerStacks( x, [ 0, 2 ] ); // Perform manual iteration... while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( ndarray2array( v.value ) ); } // Create an iterator for iterating over matrices: it = nditerStacks( x, [ 0, 1 ] ); // Perform manual iteration... while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( ndarray2array( v.value ) ); } ```
* * * ## See Also - [`@stdlib/ndarray-iter/columns`][@stdlib/ndarray/iter/columns]: create an iterator which iterates over each column in a matrix (or stack of matrices). - [`@stdlib/ndarray-iter/matrices`][@stdlib/ndarray/iter/matrices]: create an iterator which iterates over each matrix in a stack of matrices. - [`@stdlib/ndarray-iter/rows`][@stdlib/ndarray/iter/rows]: create an iterator which iterates over each row in a matrix (or stack of matrices). - [`@stdlib/ndarray-iter/subarrays`][@stdlib/ndarray/iter/subarrays]: create an iterator which iterates over each subarray in a stack of subarrays. - [`@stdlib/ndarray-slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray.
* * * ## 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

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: 23
Last Year
  • Push event: 23

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa 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 b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_bundles.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite
.github/workflows/test_coverage.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-base-zero-to ^0.2.1 development
  • @stdlib/assert-is-iterator-like ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/ndarray-array ^0.2.1 development
  • @stdlib/ndarray-slice ^0.2.2 development
  • @stdlib/ndarray-to-array ^0.2.1 development
  • @stdlib/ndarray-zeros ^0.3.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-copy ^0.2.2
  • @stdlib/array-base-put ^0.0.2
  • @stdlib/array-base-take ^0.3.0
  • @stdlib/array-base-zeros ^0.2.2
  • @stdlib/assert-has-own-property ^0.2.2
  • @stdlib/assert-is-boolean ^0.2.2
  • @stdlib/assert-is-integer-array ^0.2.2
  • @stdlib/assert-is-ndarray-like ^0.2.2
  • @stdlib/assert-is-plain-object ^0.2.2
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/ndarray-base-assert-is-read-only ^0.2.2
  • @stdlib/ndarray-base-next-cartesian-index ^0.2.2
  • @stdlib/ndarray-base-normalize-index ^0.2.2
  • @stdlib/ndarray-base-numel ^0.2.2
  • @stdlib/ndarray-base-slice ^0.2.2
  • @stdlib/ndarray-shape ^0.2.2
  • @stdlib/slice-base-args2multislice ^0.2.2
  • @stdlib/string-format ^0.2.2
  • @stdlib/symbol-iterator ^0.2.2
  • @stdlib/types ^0.4.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2