Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/math-base-special-maxabsn

Return the maximum absolute value.
https://github.com/stdlib-js/math-base-special-maxabsn

abs absolute greatest javascript largest magnitude math mathematics max maximum node node-js nodejs stdlib value

Last synced: 1 day ago
JSON representation

Return the maximum absolute value.

Awesome Lists containing this project

README 

        



  

    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!



# maxabsn



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Return the maximum absolute value.



## Installation



```bash

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

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] 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



```javascript

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

```



#### maxabsn( \[x\[, y\[, ...args]]] )



Returns the maximum absolute value.



```javascript

var v = maxabsn( -4.2, 3.14 );

// returns 4.2



v = maxabsn( +0.0, -0.0 );

// returns +0.0



v = maxabsn( 4.2, 3.14, -1.0, 6.8 );

// returns 6.8

```



If any argument is `NaN`, the function returns `NaN`.



```javascript

var v = maxabsn( 4.2, NaN );

// returns NaN



v = maxabsn( NaN, 3.14 );

// returns NaN

```



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



```javascript

var v = maxabsn();

// 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, the function returns `+infinity` (i.e., the absolute value of negative infinity).



## Examples



```javascript

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

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



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 = maxabsn( x, y );

    console.log( 'maxabs(%d,%d) = %d', x, y, v );

}

```



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-maxabsn.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-maxabsn



[test-image]: https://github.com/stdlib-js/math-base-special-maxabsn/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-base-special-maxabsn/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-maxabsn/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-maxabsn?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/math-base-special-maxabsn/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-special-maxabsn/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-special-maxabsn/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-special-maxabsn/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-special-maxabsn/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-special-maxabsn/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-special-maxabsn/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-maxabsn/main/LICENSE