@stdlib/stats-base-min NPM

min

Calculate the minimum value of a strided array.

Installation

npm install @stdlib/stats-base-min

Usage

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

min( N, x, stride )

Computes the minimum value of a strided array x.

var x = [ 1.0, -2.0, 2.0 ];
var N = x.length;

var v = min( N, x, 1 );
// returns -2.0

The function has the following parameters:

N: number of indexed elements.
x: input Array or typed array.
stride: index increment for x.

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

var floor = require( '@stdlib/math-base-special-floor' );

var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
var N = floor( x.length / 2 );

var v = min( N, x, 2 );
// returns -2.0

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

var Float64Array = require( '@stdlib/array-float64' );
var floor = require( '@stdlib/math-base-special-floor' );

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 N = floor( x0.length / 2 );

var v = min( N, x1, 2 );
// returns -2.0

min.ndarray( N, x, stride, offset )

Computes the minimum value of a strided array using alternative indexing semantics.

var x = [ 1.0, -2.0, 2.0 ];
var N = x.length;

var v = min.ndarray( N, x, 1, 0 );
// returns -2.0

The function has the following additional parameters:

offset: 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 minimum value for every other value in x starting from the second value

var floor = require( '@stdlib/math-base-special-floor' );

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
var N = floor( x.length / 2 );

var v = min.ndarray( N, x, 2, 1 );
// returns -2.0

Notes

If N <= 0, both functions return NaN.
Depending on the environment, the typed versions (dmin, smin, etc.) are likely to be significantly more performant.

Examples

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

var x;
var i;

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

var v = min( x.length, x, 1 );
console.log( v );

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.