Package Exports

@stdlib/math-base-special-minabs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-minabs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

minabs

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Return the minimum absolute value.

Installation

npm install @stdlib/math-base-special-minabs

Usage

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

minabs( [x[, y[, ...args]]] )

Returns the minimum absolute value.

var v = minabs( -4.2, 3.14 );
// returns 3.14

v = minabs( +0.0, -0.0 );
// returns +0.0

v = minabs( 4.2, 3.14, -1.0, 6.8 );
// returns 1.0

If any argument is NaN, the function returns NaN.

var v = minabs( 4.2, NaN );
// returns NaN

v = minabs( NaN, 3.14 );
// returns NaN

If not provided any arguments, the function returns +infinity.

var v = minabs();
// returns Infinity

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. 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 thus, minabs() = +infinity.

Examples

var randu = require( '@stdlib/random-base-randu' );
var minabs = require( '@stdlib/math-base-special-minabs' );

var x;
var y;
var v;
var i;

for ( i = 0; i < 100; i++ ) {
    x = ( randu()*1000.0 ) - 500.0;
    y = ( randu()*1000.0 ) - 500.0;
    v = minabs( x, y );
    console.log( 'minabs(%d,%d) = %d', x, y, 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.

@stdlib/math-base-special-minabs