Skip to content

Latest commit

 

History

History
190 lines (117 loc) · 6 KB

README.md

File metadata and controls

190 lines (117 loc) · 6 KB

nanmin

Calculate the minimum value of a strided array, ignoring NaN values.

Usage

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

nanmin( N, x, strideX )

Computes the minimum value of a strided array, ignoring NaN values.

var x = [ 1.0, -2.0, NaN, 2.0 ];

var v = nanmin( 4, x, 1 );
// returns -2.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Array or typed array.
  • strideX: stride length for x.

The N and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum 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, NaN, NaN ];

var v = nanmin( 5, 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 x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var v = nanmin( 4, x1, 2 );
// returns -2.0

nanmin.ndarray( N, x, strideX, offsetX )

Computes the minimum value of a strided array, ignoring NaN values and using alternative indexing semantics.

var x = [ 1.0, -2.0, NaN, 2.0 ];

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

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

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 2.0, 3.0, 4.0 ];

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

Notes

  • If N <= 0, both functions return NaN.
  • Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array/base/accessor).
  • Depending on the environment, the typed versions (dnanmin, snanmin, etc.) are likely to be significantly more performant.

Examples

var uniform = require( '@stdlib/random/base/uniform' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var nanmin = require( '@stdlib/stats/base/nanmin' );

function rand() {
    if ( bernoulli( 0.8 ) < 1 ) {
        return NaN;
    }
    return uniform( -50.0, 50.0 );
}

var x = filledarrayBy( 10, 'float64', rand );
console.log( x );

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

See Also