@stdlib/math-base-special-minmaxn
v0.2.2
Published
Return the minimum and maximum values.
Downloads
20
Readme
minmaxn
Return the minimum and maximum values.
Installation
npm install @stdlib/math-base-special-minmaxn
Usage
var minmaxn = require( '@stdlib/math-base-special-minmaxn' );
minmaxn( [x[, y[, ...args]]] )
Returns the minimum and maximum values in a single pass.
var v = minmaxn( 4.2, 3.14 );
// returns [ 3.14, 4.2 ]
v = minmaxn( +0.0, -0.0 );
// returns [ -0.0, +0.0 ]
v = minmaxn( 4.2, 3.14, -1.0, 6.8 );
// returns [ -1.0, 6.8 ]
If any argument is NaN
, the function returns NaN
for both the minimum value and the maximum value.
var v = minmaxn( 4.2, NaN );
// returns [ NaN, NaN ]
v = minmaxn( NaN, 3.14 );
// returns [ NaN, NaN ]
minmaxn.assign( [x[, y[, ...args]]], out, stride, offset )
Returns the minimum and maximum values in a single pass and assigns results to a provided output array.
var Float64Array = require( '@stdlib/array-float64' );
var out = new Float64Array( 2 );
var v = minmaxn.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
// returns <Float64Array>[ -2.0, 5.0 ]
var bool = ( v === out );
// returns true
Notes
- When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound and negative infinity is the least upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum and negative infinity is the identity element for the maximum, and thus, if not provided any arguments, the function returns positive infinity for the minimum value and negative infinity for the maximum value.
Examples
var minstd = require( '@stdlib/random-base-minstd-shuffle' );
var minmaxn = require( '@stdlib/math-base-special-minmaxn' );
var x;
var y;
var v;
var i;
for ( i = 0; i < 100; i++ ) {
x = minstd();
y = minstd();
v = minmaxn( x, y );
console.log( 'minmax(%d,%d) = [%d, %d]', x, y, v[0], v[1] );
}
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-2024. The Stdlib Authors.