Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
234 changes: 234 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
<!--

@license Apache-2.0

Copyright (c) 2025 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.

-->

# maxf

> Return the maximum single-precision floating-point number.

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

#### maxf( x, y )

Returns the maximum single-precision floating-point number.

```javascript
var v = maxf( 4.2, 3.14 );
// returns ~4.2
```

</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">

## Notes

- The implementation **ignores** the sign of `0`.

```javascript
var v = maxf( +0.0, -0.0 );
// returns -0.0

v = maxf( -0.0, +0.0 );
// returns +0.0
```

- The implementation does **not** check for `NaN` arguments.

```javascript
var v = maxf( 3.14, NaN );
// returns NaN

v = maxf( NaN, 3.14 );
// returns ~3.14
```

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var minstd = require( '@stdlib/random/base/minstd-shuffle' );
var maxf = require( '@stdlib/math/base/special/fast/maxf' );

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

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

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- 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 -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/math/base/special/fast/maxf.h"
```

#### stdlib_base_fast_maxf( x, y )

Returns the maximum single-precision floating-point number.

```c
float out = stdlib_base_fast_maxf( 4.2f, 3.14f );
// returns 4.2f

out = stdlib_base_fast_maxf( 0.0f, -0.0f );
// returns 0.0f
```

The function accepts the following arguments:

- **x**: `[in] float` input value.
- **y**: `[in] float` input value.

```c
float stdlib_base_fast_maxf( const float x, const float y );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/math/base/special/fast/maxf.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
float x;
float y;
float v;
int i;

for ( i = 0; i < 100; i++ ) {
x = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f;
y = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f;
v = stdlib_base_fast_maxf( x, y );
printf( "x: %f, y: %f, maxf(x, y): %f\n", x, y, v );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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 related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pkg = require( './../package.json' ).name;
var maxf = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var opts;
var x;
var y;
var z;
var i;

opts = {
'dtype': 'float32'
};

x = uniform( 100, -100.0, 100.0, opts );
y = uniform( 100, -100.0, 100.0, opts );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
z = maxf( x[ i % x.length ], y[ i % y.length ] );
if ( isnanf( z ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( z ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var maxf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( maxf instanceof Error )
};


// MAIN //

bench( pkg + '::native', opts, function benchmark( b ) {
var opts;
var x;
var y;
var z;
var i;

opts = {
'dtype': 'float32'
};
x = uniform( 100, -100.0, 100.0, opts );
y = uniform( 100, -100.0, 100.0, opts );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
z = maxf( x[ i % x.length ], y[ i % y.length ] );
if ( isnanf( z ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( z ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading