Skip to content

Latest commit

 

History

History
261 lines (158 loc) · 8.77 KB

README.md

File metadata and controls

261 lines (158 loc) · 8.77 KB
Raw
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!

minn

NPM version Build Status Coverage Status

Return the minimum value.

Installation

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

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 minn = require( '@stdlib/math-base-special-minn' );

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

Returns the minimum value.

var v = minn( 4.2, 3.14 );
// returns 3.14

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

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

If any argument is NaN, the function returns NaN.

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

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

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

var v = minn();
// 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, the function returns +infinity.

Examples

var minstd = require( '@stdlib/random-base-minstd-shuffle' );
var minn = require( '@stdlib/math-base-special-minn' );

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

for ( i = 0; i < 100; i++ ) {
    x = minstd();
    y = minstd();
    v = minn( x, y );
    console.log( 'min(%d,%d) = %d', x, y, v );
}

See Also

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-2024. The Stdlib Authors.