@stdlib/math-base-special-max
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    max

    NPM version Build Status Coverage Status dependencies

    Return the maximum value.

    Installation

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

    Usage

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

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

    Returns the maximum value.

    var v = max( 4.2, 3.14 );
    // returns 4.2
    
    v = max( +0.0, -0.0 );
    // returns +0.0
    
    v = max( 4.2, 3.14, -1.0, 6.8 );
    // returns 6.8

    If any argument is NaN, the function returns NaN.

    var v = max( 4.2, NaN );
    // returns NaN
    
    v = max( NaN, 3.14 );
    // returns NaN

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

    var v = max();
    // returns -Infinity

    Notes

    • When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), 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, negative infinity is the identity element for the maximum, and thus, max() = -infinity.

    Examples

    var minstd = require( '@stdlib/random-base-minstd-shuffle' );
    var max = require( '@stdlib/math-base-special-max' );
    
    var x;
    var y;
    var v;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        x = minstd();
        y = minstd();
        v = max( x, y );
        console.log( 'max(%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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/math-base-special-max

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    8,070

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    38.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser