Nightly Procrastination Machine

# npm

## @stdlib/stats-base-cumaxabs

0.0.8 • Public • Published

# cumaxabs

Calculate the cumulative maximum absolute value of a strided array.

## Installation

`npm install @stdlib/stats-base-cumaxabs`

## Usage

`var cumaxabs = require( '@stdlib/stats-base-cumaxabs' );`

#### cumaxabs( N, x, strideX, y, strideY )

Computes the cumulative maximum absolute value of a strided array.

```var x = [ 1.0, -2.0, 2.0 ];
var y = [ 0.0, 0.0, 0.0 ];

cumaxabs( x.length, x, 1, y, 1 );
// y => [ 1.0, 2.0, 2.0 ]```

The function has the following parameters:

The `N` and `stride` parameters determine which elements in `x` and `y` are accessed at runtime. For example, to compute the cumulative maximum absolute value of every other element in `x`,

```var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

var v = cumaxabs( 4, x, 2, y, 1 );
// y => [ 1.0, 2.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]```

Note that indexing is relative to the first index. To introduce an offset, use `typed array` views.

```var Float64Array = require( '@stdlib/array-float64' );

// Initial arrays...
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var y0 = new Float64Array( x0.length );

// Create offset views...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element

cumaxabs( 4, x1, -2, y1, 1 );
// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 4.0, 4.0, 4.0, 0.0 ]```

#### cumaxabs.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Computes the cumulative maximum absolute value of a strided array using alternative indexing semantics.

```var x = [ 1.0, -2.0, 2.0 ];
var y = [ 0.0, 0.0, 0.0 ];

cumaxabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
// y => [ 1.0, 2.0, 2.0 ]```

The function has the following additional parameters:

• offsetX: starting index for `x`.
• offsetY: starting index for `y`.

While `typed array` views mandate a view offset based on the underlying `buffer`, `offsetX` and `offsetY` parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum absolute value of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element

```var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

cumaxabs.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
// y => [ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0, 2.0, 1.0 ]```

## Examples

```var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var Float64Array = require( '@stdlib/array-float64' );
var cumaxabs = require( '@stdlib/stats-base-cumaxabs' );

var y;
var x;
var i;

x = new Float64Array( 10 );
y = new Float64Array( x.length );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
console.log( x );
console.log( y );

cumaxabs( x.length, x, 1, y, -1 );
console.log( y );```

## Notice

This package is part of 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, see the main project repository.

### Install

`npm i @stdlib/stats-base-cumaxabs`

### Repository

github.com/stdlib-js/stats-base-cumaxabs

stdlib.io

42

0.0.8

Apache-2.0

44.9 kB

11