@stdlib/math-base-special-max

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!

max

Return the maximum value.

Installation

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

Usage

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

max( x, y )

Returns the maximum value.

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

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

If any argument is NaN, the function returns NaN.

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

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

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 );
}

---

C APIs

Usage

#include "stdlib/math/base/special/max.h"

stdlib_base_max( x, y )

Returns the maximum value.

double out = stdlib_base_max( 4.2, 3.14 );
// returns 4.2

out = stdlib_base_max( 0.0, -0.0 );
// returns 0.0

The function accepts the following arguments:

• x: [in] double input value.
• y: [in] double input value.

double stdlib_base_max( const double x, const double y );

Examples

#include "stdlib/math/base/special/max.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
    double x;
    double y;
    double v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        y = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        v = stdlib_base_max( x, y );
        printf( "x: %lf, y: %lf, max(x, y): %lf\n", x, y, v );
    }
}

---

See Also

• @stdlib/math-base/special/maxabs: return the maximum absolute value.
• @stdlib/math-base/special/maxn: return the maximum value.
• @stdlib/math-base/special/min: return the minimum value.

---

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.

Changelog

0.3.0 (2024-07-28)

<section class="features">

Features

• 6831521 - add C implementation for math/base/special/max

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• e247f31 - docs: fix function names in C example code (by Philipp Burckhardt)
• d40dbaf - chore: update package meta data (#1812) (by stdlib-bot)
• 6831521 - feat: add C implementation for math/base/special/max (by Shashank Shekhar Singh, Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt
• Shashank Shekhar Singh

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">