-
-
Notifications
You must be signed in to change notification settings - Fork 900
feat: add math/base/special/fast/maxf
#8105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
594602f
feat: add `math/base/special/fast/maxf`
nakul-krishnakumar 2ecaa8f
docs: update return annotation
kgryte f0a6592
docs: update return annotation
kgryte 0ae08e3
style: fix spacing
kgryte a969c26
style: fix spacing
kgryte b252bbd
docs: update return annotations
kgryte c9a66c7
docs: use approximate rather than exact values
kgryte bddb535
docs: update return annotations
kgryte 2a2b10b
docs: update return annotations
kgryte fa2233e
docs: update return annotations
kgryte 00b3c5f
docs: update return annotations
kgryte 494f148
docs: update example
kgryte fcb88ab
docs: update example
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
234 changes: 234 additions & 0 deletions
234
lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.140000104904175 | ||
``` | ||
|
||
</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 --> |
59 changes: 59 additions & 0 deletions
59
lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) { | ||
kgryte marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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(); | ||
}); |
67 changes: 67 additions & 0 deletions
67
lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) { | ||
kgryte marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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(); | ||
}); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.