@stdlib/stats-array-min
v0.1.1
Published
Calculate the minimum value of an array.
Downloads
169
Readme
min
Calculate the minimum value of an array.
Installation
npm install @stdlib/stats-array-minUsage
var min = require( '@stdlib/stats-array-min' );min( x )
Computes the minimum value of an array.
var x = [ 1.0, -2.0, 2.0 ];
var v = min( x );
// returns -2.0The function has the following parameters:
- x: input array.
Notes
- If provided an empty array, the function returns
NaN. - The function supports array-like objects having getter and setter accessors for array element access (e.g.,
@stdlib/array-base/accessor).
Examples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var min = require( '@stdlib/stats-array-min' );
var x = discreteUniform( 10, -50, 50, {
'dtype': 'float64'
});
console.log( x );
var v = min( x );
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
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
