Skip to content

Calculate the minimum value of an array via a callback function, ignoring NaN values.

License

Notifications You must be signed in to change notification settings

stdlib-js/stats-array-nanmin-by

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!

nanminBy

NPM version Build Status Coverage Status

Calculate the minimum value of an array via a callback function, ignoring NaN values.

Installation

npm install @stdlib/stats-array-nanmin-by

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var nanminBy = require( '@stdlib/stats-array-nanmin-by' );

nanminBy( x, clbk[, thisArg] )

Computes the minimum value of an array via a callback function, ignoring NaN values.

function accessor( v ) {
    return v * 2.0;
}

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

var v = nanminBy( x, accessor );
// returns -10.0

The function has the following parameters:

  • x: input array.
  • clbk: callback function.
  • thisArg: execution context (optional).

The invoked callback is provided three arguments:

  • value: current array element.
  • index: current array index.
  • array: input array.

To set the callback execution context, provide a thisArg.

function accessor( v ) {
    this.count += 1;
    return v * 2.0;
}

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

var context = {
    'count': 0
};

var v = nanminBy( x, accessor, context );
// returns -10.0

var cnt = context.count;
// returns 10

Notes

  • If provided an empty array, the function returns NaN.
  • A provided callback function should return a numeric value.
  • If a provided callback function returns NaN, the value is ignored.
  • If a provided callback function does not return any value (or equivalently, explicitly returns undefined), the value is ignored.
  • The function supports array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array-base/accessor).

Examples

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

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

function accessor( v ) {
    return v * 2.0;
}

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

var v = nanminBy( x, accessor );
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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

About

Calculate the minimum value of an array via a callback function, ignoring NaN values.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published