ndarray-base-unary-strided1d

Apply a one-dimensional strided array function to a list of specified dimensions in an input ndarray and assign results to a provided output ndarray.

https://github.com/stdlib-js/ndarray-base-unary-strided1d

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

Keywords

accumulate accumulation apply array base cumulative javascript ndarray node node-js nodejs stdlib strided unary vector

Last synced: 6 months ago · JSON representation ·

Repository

Apply a one-dimensional strided array function to a list of specified dimensions in an input ndarray and assign results to a provided output 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: 1.96 MB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

accumulate accumulation apply array base cumulative javascript ndarray node node-js nodejs stdlib strided unary vector

Created 10 months 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!

unaryStrided1d

Apply a one-dimensional strided array function to a list of specified dimensions in an input ndarray and assign results to a provided output ndarray.

## Installation ```bash npm install @stdlib/ndarray-base-unary-strided1d ``` 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 unaryStrided1d = require( '@stdlib/ndarray-base-unary-strided1d' ); ``` #### unaryStrided1d( fcn, arrays, dims\[, options] ) Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray and assigns results to a provided output ndarray. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var ndarray2array = require( '@stdlib/ndarray-base-to-array' ); var getStride = require( '@stdlib/ndarray-base-stride' ); var getOffset = require( '@stdlib/ndarray-base-offset' ); var getData = require( '@stdlib/ndarray-base-data-buffer' ); var numelDimension = require( '@stdlib/ndarray-base-numel-dimension' ); var ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' ); var gcusum = require( '@stdlib/blas-ext-base-gcusum' ).ndarray; function wrapper( arrays ) { var x = arrays[ 0 ]; var y = arrays[ 1 ]; var s = arrays[ 2 ]; return gcusum( numelDimension( x, 0 ), ndarraylike2scalar( s ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); } // Create data buffers: var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); // Define the array shapes: var xsh = [ 1, 3, 2, 2 ]; var ysh = [ 1, 3, 2, 2 ]; // Define the array strides: var sx = [ 12, 4, 2, 1 ]; var sy = [ 12, 4, 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 ndarray-like object for the initial sum: var initial = { 'dtype': 'float64', 'data': new Float64Array( [ 0.0 ] ), 'shape': [ 1, 3 ], 'strides': [ 0, 0 ], 'offset': 0, 'order': 'row-major' }; // Create an output ndarray-like object: var y = { 'dtype': 'float64', 'data': ybuf, 'shape': ysh, 'strides': sy, 'offset': oy, 'order': 'row-major' }; // Apply strided function: unaryStrided1d( wrapper, [ x, y, initial ], [ 2, 3 ] ); var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ); // returns [ [ [ [ 1.0, 3.0 ], [ 6.0, 10.0 ] ], [ [ 5.0, 11.0 ], [ 18.0, 26.0 ] ], [ [ 9.0, 19.0 ], [ 30.0, 42.0 ] ] ] ] ``` The function accepts the following arguments: - **fcn**: function which will be applied to a one-dimensional input subarray and should update a one-dimensional output subarray with results. - **arrays**: array-like object containing one input ndarray and one output ndarray, followed by any additional ndarray arguments. - **dims**: list of dimensions to which to apply a strided array function. - **options**: function options which are passed through to `fcn` (_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). #### TODO: document factory method

## Notes - Any additional ndarray arguments are expected to have the same dimensions as the loop dimensions of the input ndarray. When calling the strided array function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects. - The strided array function is expected to have the following signature: ```text fcn( arrays[, options] ) ``` where - **arrays**: array containing a one-dimensional subarray of the input ndarray, a one-dimensional subarray of the output ndarray, and any additional ndarray arguments as zero-dimensional ndarrays. - **options**: function options (_optional_). - The function iterates over ndarray elements according to the memory layout of the input ndarray. - For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing an operation in order to achieve better performance.

## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var zeros = require( '@stdlib/array-base-zeros' ); var ndarray2array = require( '@stdlib/ndarray-base-to-array' ); var numelDimension = require( '@stdlib/ndarray-base-numel-dimension' ); var getData = require( '@stdlib/ndarray-base-data-buffer' ); var getStride = require( '@stdlib/ndarray-base-stride' ); var getOffset = require( '@stdlib/ndarray-base-offset' ); var ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' ); var gcusum = require( '@stdlib/blas-ext-base-gcusum' ).ndarray; var unaryStrided1d = require( '@stdlib/ndarray-base-unary-strided1d' ); function wrapper( arrays ) { var x = arrays[ 0 ]; var y = arrays[ 1 ]; var s = arrays[ 2 ]; return gcusum( numelDimension( x, 0 ), ndarraylike2scalar( s ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); } var N = 10; var x = { 'dtype': 'generic', 'data': discreteUniform( N, -5, 5, { 'dtype': 'generic' }), 'shape': [ 1, 5, 2 ], 'strides': [ 10, 2, 1 ], 'offset': 0, 'order': 'row-major' }; var initial = { 'dtype': 'generic', 'data': [ 0.0 ], 'shape': [ 1, 2 ], 'strides': [ 0, 0 ], 'offset': 0, 'order': 'row-major' }; var y = { 'dtype': 'generic', 'data': zeros( N ), 'shape': [ 1, 5, 2 ], 'strides': [ 10, 2, 1 ], 'offset': 0, 'order': 'row-major' }; unaryStrided1d( wrapper, [ x, y, initial ], [ 1 ] ); 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

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

Member event: 1
Push event: 36
Create event: 3

Last Year

Member event: 1
Push event: 36
Create event: 3

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/assert-is-function ^0.2.2 development
@stdlib/blas-ext-base-gcusum ^0.2.2 development
@stdlib/ndarray-base-data-buffer ^0.2.2 development
@stdlib/ndarray-base-numel-dimension ^0.3.2 development
@stdlib/ndarray-base-offset ^0.2.2 development
@stdlib/ndarray-base-stride ^0.2.2 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-copy-indexed ^0.2.2
@stdlib/array-base-indices-complement github:stdlib-js/array-base-indices-complement#main
@stdlib/array-base-join ^0.1.1
@stdlib/array-base-take-indexed ^0.2.2
@stdlib/array-base-take-indexed2 github:stdlib-js/array-base-take-indexed2#main
@stdlib/array-base-zeros ^0.2.2
@stdlib/error-tools-fmtprodmsg ^0.2.2
@stdlib/ndarray-base-assert-is-row-major-string github:stdlib-js/ndarray-base-assert-is-row-major-string#main
@stdlib/ndarray-base-assign ^0.1.1
@stdlib/ndarray-base-empty-like ^0.3.0
@stdlib/ndarray-base-iteration-order ^0.2.2
@stdlib/ndarray-base-minmax-view-buffer-index ^0.2.2
@stdlib/ndarray-base-ndarraylike2ndarray github:stdlib-js/ndarray-base-ndarraylike2ndarray#main
@stdlib/ndarray-base-ndarraylike2object ^0.2.2
@stdlib/ndarray-base-numel ^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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-base-unary-strided1d

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

unaryStrided1d

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Dependencies