138 lines
3.1 KiB
Markdown
138 lines
3.1 KiB
Markdown
|
<!--
|
||
|
|
||
|
@license Apache-2.0
|
||
|
|
||
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
you may not use this file except in compliance with the License.
|
||
|
You may obtain a copy of the License at
|
||
|
|
||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
||
|
Unless required by applicable law or agreed to in writing, software
|
||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
See the License for the specific language governing permissions and
|
||
|
limitations under the License.
|
||
|
|
||
|
-->
|
||
|
|
||
|
# minmaxabs
|
||
|
|
||
|
> Return the minimum and maximum absolute values.
|
||
|
|
||
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="intro">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.intro -->
|
||
|
|
||
|
<!-- Package usage documentation. -->
|
||
|
|
||
|
<section class="usage">
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
```javascript
|
||
|
var minmaxabs = require( '@stdlib/math/base/special/minmaxabs' );
|
||
|
```
|
||
|
|
||
|
#### minmaxabs( \[out,] x\[, y\[, ...args]] )
|
||
|
|
||
|
Returns the minimum and maximum absolute values in a single pass.
|
||
|
|
||
|
```javascript
|
||
|
var v = minmaxabs( 4.2, 3.14 );
|
||
|
// returns [ 3.14, 4.2 ]
|
||
|
|
||
|
v = minmaxabs( +0.0, -0.0 );
|
||
|
// returns [ 0.0, 0.0 ]
|
||
|
|
||
|
v = minmaxabs( 4.2, 3.14, -1.0, -6.8 );
|
||
|
// returns [ 1.0, 6.8 ]
|
||
|
```
|
||
|
|
||
|
If any argument is `NaN`, the function returns `NaN` for both the minimum value and the maximum value.
|
||
|
|
||
|
```javascript
|
||
|
var v = minmaxabs( 4.2, NaN );
|
||
|
// returns [ NaN, NaN ]
|
||
|
|
||
|
v = minmaxabs( NaN, 3.14 );
|
||
|
// returns [ NaN, NaN ]
|
||
|
```
|
||
|
|
||
|
By default, the function returns minimum and maximum absolute values as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
|
||
|
|
||
|
```javascript
|
||
|
var Float64Array = require( '@stdlib/array/float64' );
|
||
|
|
||
|
var out = new Float64Array( 2 );
|
||
|
|
||
|
var v = minmaxabs( out, 5.0, 3.0, -2.0, 1.0 );
|
||
|
// returns <Float64Array>[ 1.0, 5.0 ]
|
||
|
|
||
|
var bool = ( v === out );
|
||
|
// returns true
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.usage -->
|
||
|
|
||
|
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="notes">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.notes -->
|
||
|
|
||
|
<!-- Package usage examples. -->
|
||
|
|
||
|
<section class="examples">
|
||
|
|
||
|
## Examples
|
||
|
|
||
|
<!-- eslint no-undef: "error" -->
|
||
|
|
||
|
```javascript
|
||
|
var randu = require( '@stdlib/random/base/randu' );
|
||
|
var minmaxabs = require( '@stdlib/math/base/special/minmaxabs' );
|
||
|
|
||
|
var x;
|
||
|
var y;
|
||
|
var v;
|
||
|
var i;
|
||
|
|
||
|
for ( i = 0; i < 100; i++ ) {
|
||
|
x = ( randu()*100.0 ) - 50.0;
|
||
|
y = ( randu()*100.0 ) - 50.0;
|
||
|
v = minmaxabs( x, y );
|
||
|
console.log( 'minmaxabs(%d,%d) = [%d, %d]', x, y, v[0], v[1] );
|
||
|
}
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.examples -->
|
||
|
|
||
|
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="references">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.references -->
|
||
|
|
||
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="links">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.links -->
|