Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-base-unary-reduce-subarray-by

Perform a reduction over a list of specified dimensions in an input ndarray according to a callback function and assign results to a provided output ndarray.

https://github.com/stdlib-js/ndarray-base-unary-reduce-subarray-by

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.6%) to scientific vocabulary

Keywords

accumulate accumulation array base javascript ndarray node node-js nodejs reduce reduction stdlib strided subarray unary
Last synced: 4 months ago · JSON representation ·

Repository

Perform a reduction over a list of specified dimensions in an input ndarray according to a callback function and assign results to a provided output ndarray.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
accumulate accumulation array base javascript ndarray node node-js nodejs reduce reduction stdlib strided subarray unary
Created 7 months ago · Last pushed 5 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!

unaryReduceSubarrayBy

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

Perform a reduction over a list of specified dimensions in an input ndarray according to a callback function and assign results to a provided output ndarray.

## Installation ```bash npm install @stdlib/ndarray-base-unary-reduce-subarray-by ``` 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 unaryReduceSubarrayBy = require( '@stdlib/ndarray-base-unary-reduce-subarray-by' ); ``` #### unaryReduceSubarrayBy( fcn, arrays, dims\[, options], clbk\[, thisArg] ) Performs a reduction over a list of specified dimensions in an input ndarray according to a callback function and assigns results to a provided output ndarray. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var filled = require( '@stdlib/array-base-filled' ); var ndarray2array = require( '@stdlib/ndarray-base-to-array' ); var everyBy = require( '@stdlib/ndarray-base-every-by' ); function clbk( value ) { return value > 0.0; } // Create data buffers: var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); var ybuf = filled( false, 3 ); // Define the array shapes: var xsh = [ 1, 3, 2, 2 ]; var ysh = [ 1, 3 ]; // Define the array strides: var sx = [ 12, 4, 2, 1 ]; var sy = [ 3, 1 ]; // Define the index offsets: var ox = 0; var oy = 0; // Create an input ndarray-like object: var x = { 'dtype': 'float64', 'data': xbuf, 'shape': xsh, 'strides': sx, 'offset': ox, 'order': 'row-major' }; // Create an output ndarray-like object: var y = { 'dtype': 'generic', 'data': ybuf, 'shape': ysh, 'strides': sy, 'offset': oy, 'order': 'row-major' }; // Perform a reduction: unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], clbk ); var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ); // returns [ [ true, false, true ] ] ``` The function accepts the following arguments: - **fcn**: function which will be applied to a subarray and should reduce the subarray to a single scalar value. - **arrays**: array-like object containing one input ndarray and one output ndarray, followed by any additional ndarray arguments. - **dims**: list of dimensions over which to perform a reduction. - **options**: function options which are passed through to `fcn` (_optional_). - **clbk**: callback function. - **thisArg**: callback execution context (_optional_). Each provided ndarray should be an object with the following properties: - **dtype**: data type. - **data**: data buffer. - **shape**: dimensions. - **strides**: stride lengths. - **offset**: index offset. - **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style). The invoked callback function is provided the following arguments: - **value**: input array element. - **indices**: current array element indices. - **arr**: the input ndarray. To set the callback execution context, provide a `thisArg`. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var filled = require( '@stdlib/array-base-filled' ); var ndarray2array = require( '@stdlib/ndarray-base-to-array' ); var everyBy = require( '@stdlib/ndarray-base-every-by' ); function clbk( value ) { this.count += 1; return value > 0.0; } // Create data buffers: var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); var ybuf = filled( false, 6 ); // Define the array shapes: var xsh = [ 3, 2, 2 ]; var ysh = [ 3, 2 ]; // Define the array strides: var sx = [ 4, 2, 1 ]; var sy = [ 2, 1 ]; // Define the index offsets: var ox = 0; var oy = 0; // Create an input ndarray-like object: var x = { 'dtype': 'float64', 'data': xbuf, 'shape': xsh, 'strides': sx, 'offset': ox, 'order': 'row-major' }; // Create an output ndarray-like object: var y = { 'dtype': 'generic', 'data': ybuf, 'shape': ysh, 'strides': sy, 'offset': oy, 'order': 'row-major' }; var ctx = { 'count': 0 }; // Perform a reduction: unaryReduceSubarrayBy( everyBy, [ x, y ], [ 1 ], clbk, ctx ); var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ); // returns [ [ true, true ], [ true, false ], [ true, true ] ] var count = ctx.count; // returns 11 ``` #### TODO: document factory method
## Notes - The output ndarray and any additional ndarray arguments are expected to have the same dimensions as the non-reduced dimensions of the input ndarray. When calling the reduction function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects. - The reduction function is expected to have the following signature: ```text fcn( arrays[, options], wrappedCallback ) ``` where - **arrays**: array containing a subarray of the input ndarray and any additional ndarray arguments as zero-dimensional ndarrays. - **options**: function options (_optional_). - **wrappedCallback**: callback function. This function is a wrapper around a provided `clbk` argument. - For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing a reduction in order to achieve better performance.
## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var filled = require( '@stdlib/array-base-filled' ); var ndarray2array = require( '@stdlib/ndarray-base-to-array' ); var everyBy = require( '@stdlib/ndarray-base-every-by' ); var unaryReduceSubarrayBy = require( '@stdlib/ndarray-base-unary-reduce-subarray-by' ); function clbk( value ) { return value > -3; } var x = { 'dtype': 'generic', 'data': discreteUniform( 40, -5, 5, { 'dtype': 'generic' }), 'shape': [ 2, 5, 2, 2 ], 'strides': [ 1, 2, 10, 20 ], 'offset': 0, 'order': 'column-major' }; var y = { 'dtype': 'generic', 'data': filled( false, 10 ), 'shape': [ 2, 5 ], 'strides': [ 1, 2 ], 'offset': 0, 'order': 'column-major' }; unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], clbk ); console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) ); console.log( ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ) ); ```
* * * ## 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
  • Member event: 1
  • Push event: 11
  • Create event: 6
Last Year
  • Member event: 1
  • Push event: 11
  • Create event: 6

Issues and Pull Requests

Last synced: 7 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/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-filled ^0.2.2 development
  • @stdlib/ndarray-base-every-by github:stdlib-js/ndarray-base-every-by#main development
  • @stdlib/ndarray-base-to-array ^0.2.1 development
  • @stdlib/random-array-discrete-uniform ^0.2.1 development
  • istanbul ^0.4.1 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-indices-complement github:stdlib-js/array-base-indices-complement#main
  • @stdlib/array-base-join ^0.1.1
  • @stdlib/array-base-put ^0.0.2
  • @stdlib/array-base-reverse ^0.2.2
  • @stdlib/array-base-take-indexed ^0.2.2
  • @stdlib/array-base-take-indexed2 github:stdlib-js/array-base-take-indexed2#main
  • @stdlib/array-base-without github:stdlib-js/array-base-without#main
  • @stdlib/array-base-zero-to ^0.2.1
  • @stdlib/array-base-zeros ^0.2.2
  • @stdlib/assert-is-function ^0.2.2
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/ndarray-base-ind2sub ^0.2.2
  • @stdlib/ndarray-base-iteration-order ^0.2.2
  • @stdlib/ndarray-base-ndarraylike2object ^0.2.2
  • @stdlib/ndarray-base-numel ^0.2.2
  • @stdlib/ndarray-base-strides2order ^0.2.2
  • @stdlib/ndarray-base-to-unique-normalized-indices github:stdlib-js/ndarray-base-to-unique-normalized-indices#main
  • @stdlib/ndarray-base-unary-loop-interchange-order ^0.2.1
  • @stdlib/ndarray-base-unary-tiling-block-size ^0.2.2
  • @stdlib/ndarray-base-vind2bind ^0.2.2
  • @stdlib/string-format ^0.2.2
  • @stdlib/types ^0.4.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2