Data

Tools

Indexes

Applications

Experiments

Open Source Science

blas-ext-cusum

Compute the cumulative sum along one or more ndarray dimensions.

https://github.com/stdlib-js/blas-ext-cusum

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 (14.9%) to scientific vocabulary

Keywords

cumulative javascript math mathematics ndarray node node-js nodejs statistics stats stdlib sum summation total
Last synced: 6 months ago · JSON representation ·

Repository

Compute the cumulative sum along one or more ndarray dimensions.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
cumulative javascript math mathematics ndarray node node-js nodejs statistics stats stdlib sum summation total
Created 10 months ago · Last pushed 8 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!

cusum

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

Compute the cumulative sum along one or more ndarray dimensions.

## Installation ```bash npm install @stdlib/blas-ext-cusum ``` 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 cusum = require( '@stdlib/blas-ext-cusum' ); ``` #### cusum( x\[, initial]\[, options] ) Computes the cumulative sum along one or more [ndarray][@stdlib/ndarray/ctor] dimensions. ```javascript var ndarray2array = require( '@stdlib/ndarray-to-array' ); var array = require( '@stdlib/ndarray-array' ); var x = array( [ -1.0, 2.0, -3.0 ] ); var y = cusum( x ); // returns var arr = ndarray2array( y ); // returns [ -1.0, 1.0, -2.0 ] ``` The function has the following parameters: - **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have a numeric or "generic" [data type][@stdlib/ndarray/dtypes]. - **initial**: initial value for the cumulative sum (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] which [promotes][@stdlib/ndarray/promotion-rules] to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, an [ndarray][@stdlib/ndarray/ctor] initial value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] initial value must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor]. By default, the initial value is the additive identity (i.e., zero). - **options**: function options (_optional_). The function accepts the following options: - **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. - **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be a numeric or "generic" [data type][@stdlib/ndarray/dtypes]. By default, the function uses the additive identity when computing the cumulative sum. To begin summing from a different value, provide an `initial` argument. ```javascript var ndarray2array = require( '@stdlib/ndarray-to-array' ); var array = require( '@stdlib/ndarray-array' ); var x = array( [ -1.0, 2.0, -3.0 ] ); var y = cusum( x, 10.0 ); // returns var arr = ndarray2array( y ); // returns [ 9.0, 11.0, 8.0 ] ``` By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option. ```javascript var ndarray2array = require( '@stdlib/ndarray-to-array' ); var array = require( '@stdlib/ndarray-array' ); var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); var v = ndarray2array( x ); // returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] var y = cusum( x, { 'dims': [ 0 ] }); // returns v = ndarray2array( y ); // returns [ [ -1.0, 2.0 ], [ -4.0, 6.0 ] ] y = cusum( x, { 'dims': [ 1 ] }); // returns v = ndarray2array( y ); // returns [ [ -1.0, 1.0 ], [ -3.0, 1.0 ] ] y = cusum( x, { 'dims': [ 0, 1 ] }); // returns v = ndarray2array( y ); // returns [ [ -1.0, 1.0 ], [ -2.0, 2.0 ] ] ``` By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option. ```javascript var ndarray2array = require( '@stdlib/ndarray-to-array' ); var dtype = require( '@stdlib/ndarray-dtype' ); var array = require( '@stdlib/ndarray-array' ); var x = array( [ -1.0, 2.0, -3.0 ], { 'dtype': 'generic' }); var y = cusum( x, { 'dtype': 'float64' }); // returns var dt = dtype( y ); // returns 'float64' ``` #### cusum.assign( x\[, initial], out\[, options] ) Computes the cumulative sum along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor]. ```javascript var ndarray2array = require( '@stdlib/ndarray-to-array' ); var array = require( '@stdlib/ndarray-array' ); var zerosLike = require( '@stdlib/ndarray-zeros-like' ); var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zerosLike( x ); var out = cusum.assign( x, y ); // returns var v = ndarray2array( out ); // returns [ -1.0, 1.0, -2.0 ] var bool = ( out === y ); // returns true ``` The method has the following parameters: - **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have a numeric or generic [data type][@stdlib/ndarray/dtypes]. - **initial**: initial value for the cumulative sum (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] which [promotes][@stdlib/ndarray/promotion-rules] to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, an [ndarray][@stdlib/ndarray/ctor] initial value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] initial value must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor]. By default, the initial value is the additive identity (i.e., zero). - **out**: output [ndarray][@stdlib/ndarray/ctor]. - **options**: function options (_optional_). The method accepts the following options: - **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
## Notes - Both functions iterate over [ndarray][@stdlib/ndarray/ctor] elements according to the memory layout of the input [ndarray][@stdlib/ndarray/ctor]. Accordingly, performance degradation is possible when operating over multiple dimensions of a large non-contiguous multi-dimensional input [ndarray][@stdlib/ndarray/ctor]. In such scenarios, one may want to copy an input [ndarray][@stdlib/ndarray/ctor] to contiguous memory before computing the cumulative sum. - The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, in order to avoid issues arising from integer overflow, the function must return an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] amenable to accumulation. This means that, for integer data types having small value ranges (e.g., `int8`, `uint8`, etc), the main function returns an [ndarray][@stdlib/ndarray/ctor] having at least a 32-bit integer data type. By default, if an input [ndarray][@stdlib/ndarray/ctor] has a floating-point data type, the main function returns an [ndarray][@stdlib/ndarray/ctor] having the same data type. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var getDType = require( '@stdlib/ndarray-dtype' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var ndarray = require( '@stdlib/ndarray-ctor' ); var cusum = require( '@stdlib/blas-ext-cusum' ); // Generate an array of random numbers: var xbuf = discreteUniform( 25, 0, 20, { 'dtype': 'generic' }); // Wrap in an ndarray: var x = new ndarray( 'generic', xbuf, [ 5, 5 ], [ 5, 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); // Perform operation: var y = cusum( x, 100.0, { 'dims': [ 0 ] }); // Resolve the output array data type: var dt = getDType( y ); console.log( dt ); // Print the results: console.log( ndarray2array( y ) ); ```
* * * ## 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: 8
  • Create event: 1
Last Year
  • Member event: 1
  • Push event: 8
  • Create event: 1

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-float64 ^0.2.2 development
  • @stdlib/assert-is-method ^0.2.2 development
  • @stdlib/assert-is-same-array ^0.2.2 development
  • @stdlib/assert-is-same-float64array ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/math-base-assert-is-nan ^0.2.2 development
  • @stdlib/math-base-special-pow ^0.3.0 development
  • @stdlib/ndarray-base-ctor ^0.2.2 development
  • @stdlib/ndarray-ctor ^0.2.2 development
  • @stdlib/ndarray-data-buffer ^0.2.2 development
  • @stdlib/ndarray-empty ^0.3.0 development
  • @stdlib/ndarray-empty-like ^0.3.0 development
  • @stdlib/ndarray-from-scalar ^0.2.1 development
  • @stdlib/ndarray-to-array ^0.2.1 development
  • @stdlib/ndarray-zeros ^0.3.0 development
  • @stdlib/ndarray-zeros-like ^0.3.0 development
  • @stdlib/random-array-discrete-uniform ^0.2.1 development
  • @stdlib/random-array-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-take-indexed ^0.2.2
  • @stdlib/assert-has-own-property ^0.2.2
  • @stdlib/assert-is-complex-like ^0.2.2
  • @stdlib/assert-is-ndarray-like ^0.2.2
  • @stdlib/assert-is-number ^0.2.2
  • @stdlib/blas-ext-base-ndarray-dcusum github:stdlib-js/blas-ext-base-ndarray-dcusum#main
  • @stdlib/blas-ext-base-ndarray-gcusum github:stdlib-js/blas-ext-base-ndarray-gcusum#main
  • @stdlib/blas-ext-base-ndarray-scusum github:stdlib-js/blas-ext-base-ndarray-scusum#main
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/ndarray-base-broadcast-scalar ^0.2.2
  • @stdlib/ndarray-base-maybe-broadcast-array ^0.2.3
  • @stdlib/ndarray-base-to-unique-normalized-indices github:stdlib-js/ndarray-base-to-unique-normalized-indices#main
  • @stdlib/ndarray-base-unary-strided1d-dispatch-factory github:stdlib-js/ndarray-base-unary-strided1d-dispatch-factory#main
  • @stdlib/ndarray-dtype ^0.2.2
  • @stdlib/ndarray-dtypes ^0.3.0
  • @stdlib/ndarray-order ^0.2.2
  • @stdlib/ndarray-shape ^0.2.2
  • @stdlib/string-format ^0.2.2
  • @stdlib/types ^0.4.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2