@stdlib/stats-strided-dmaxabs
v0.1.1
Published
Calculate the maximum absolute value of a double-precision floating-point strided array.
Readme
dmaxabs
Calculate the maximum absolute value of a double-precision floating-point strided array.
Installation
npm install @stdlib/stats-strided-dmaxabsUsage
var dmaxabs = require( '@stdlib/stats-strided-dmaxabs' );dmaxabs( N, x, strideX )
Computes the maximum absolute value of a double-precision floating-point strided array x.
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
var v = dmaxabs( x.length, x, 1 );
// returns 2.0The function has the following parameters:
- N: number of indexed elements.
- x: input
Float64Array. - strideX: stride length for
x.
The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the maximum absolute value of every other element in x,
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
var v = dmaxabs( 4, x, 2 );
// returns 4.0Note that indexing is relative to the first index. To introduce an offset, use typed array views.
var Float64Array = require( '@stdlib/array-float64' );
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var v = dmaxabs( 4, x1, 2 );
// returns 4.0dmaxabs.ndarray( N, x, strideX, offsetX )
Computes the maximum absolute value of a double-precision floating-point strided array using alternative indexing semantics.
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
var v = dmaxabs.ndarray( x.length, x, 1, 0 );
// returns 2.0The function has the following additional parameters:
- offsetX: starting index for
x.
While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the maximum absolute value for every other element in x starting from the second element
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var v = dmaxabs.ndarray( 4, x, 2, 1 );
// returns 4.0Notes
- If
N <= 0, both functions returnNaN.
Examples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var dmaxabs = require( '@stdlib/stats-strided-dmaxabs' );
var x = discreteUniform( 10, -50, 50, {
'dtype': 'float64'
});
console.log( x );
var v = dmaxabs( x.length, x, 1 );
console.log( v );C APIs
Usage
#include "stdlib/stats/strided/dmaxabs.h"stdlib_strided_dmaxabs( N, *X, strideX )
Computes the maximum absolute value of a double-precision floating-point strided array.
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0 };
double v = stdlib_strided_dmaxabs( 4, x, 2 );
// returns 7.0The function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - X:
[in] double*input array. - strideX:
[in] CBLAS_INTstride length forX.
double stdlib_strided_dmaxabs( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );stdlib_strided_dmaxabs_ndarray( N, *X, strideX, offsetX )
Computes the maximum absolute value of a double-precision floating-point strided array using alternative indexing semantics.
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0 };
double v = stdlib_strided_dmaxabs_ndarray( 4, x, 2, 0 );
// returns 7.0The function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - X:
[in] double*input array. - strideX:
[in] CBLAS_INTstride length forX. - offsetX:
[in] CBLAS_INTstarting index forX.
double stdlib_strided_dmaxabs_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );Examples
#include "stdlib/stats/strided/dmaxabs.h"
#include <stdio.h>
int main( void ) {
// Create a strided array:
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0 };
// Specify the number of elements:
const int N = 4;
// Specify the stride length:
const int strideX = 2;
// Compute the maximum value:
double v = stdlib_strided_dmaxabs( N, x, strideX );
// Print the result:
printf( "maxabs: %lf\n", v );
}See Also
@stdlib/stats-strided/dmax: calculate the maximum value of a double-precision floating-point strided array.@stdlib/stats-strided/dminabs: calculate the minimum absolute value of a double-precision floating-point strided array.@stdlib/stats-strided/dnanmaxabs: calculate the maximum absolute value of a double-precision floating-point strided array, ignoring NaN values.@stdlib/stats-strided/maxabs: calculate the maximum absolute value of a strided array.@stdlib/stats-strided/smaxabs: calculate the maximum absolute value of a single-precision floating-point strided array.
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
