-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add math/base/special/fast/acoshf
#8984
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
Open
nakul-krishnakumar
wants to merge
11
commits into
stdlib-js:develop
Choose a base branch
from
nakul-krishnakumar:fast-acoshf
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
d18f275
feat: add `math/base/special/fast/acoshf`
nakul-krishnakumar 3e6d1de
chore: update copyright years
stdlib-bot db8437f
fix: add required headers for examples
nakul-krishnakumar c6d17c1
chore: update example generation loop
nakul-krishnakumar 82cc8af
style: add proper indentation
nakul-krishnakumar 3dfb21e
style: fix lint error
nakul-krishnakumar 320e383
Merge remote-tracking branch 'upstream/develop' into fast-acoshf
stdlib-bot bb526d3
chore: update copyright years
stdlib-bot 1969fd5
chore: update according to code review
nakul-krishnakumar fc55de5
bench: update benchmark to use dynamic memory allocation
nakul-krishnakumar 4d4dbee
bench: set array size to 100
nakul-krishnakumar 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
209 changes: 209 additions & 0 deletions
209
lib/node_modules/@stdlib/math/base/special/fast/acoshf/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,209 @@ | ||
| <!-- | ||
|
|
||
| @license Apache-2.0 | ||
|
|
||
| Copyright (c) 2026 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. | ||
|
|
||
| --> | ||
|
|
||
| # acoshf | ||
|
|
||
| > Compute the [hyperbolic arccosine][inverse-hyperbolic] of a single-precision floating-point number. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var acoshf = require( '@stdlib/math/base/special/fast/acoshf' ); | ||
| ``` | ||
|
|
||
| #### acoshf( x ) | ||
|
|
||
| Computes the [hyperbolic arccosine][inverse-hyperbolic] of a single-precision floating-point `number` (in radians). | ||
|
|
||
| ```javascript | ||
| var v = acoshf( 1.0 ); | ||
| // returns 0.0 | ||
|
|
||
| v = acoshf( 2.0 ); | ||
| // returns ~1.317 | ||
|
|
||
| v = acoshf( 0.5 ); | ||
| // returns NaN | ||
| ``` | ||
|
|
||
| The domain of `x` is restricted to `[1,+infinity)`. If `x < 1`, the function will return `NaN`. | ||
|
|
||
| ```javascript | ||
| var v = acoshf( 0.0 ); | ||
| // returns NaN | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - For large `x`, the function will overflow. | ||
|
|
||
| ```javascript | ||
| var v = acoshf( 1.0e308 ); | ||
| // returns Infinity | ||
| // (expected 709.889355822726) | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var uniform = require( '@stdlib/random/array/uniform' ); | ||
| var logEachMap = require( '@stdlib/console/log-each-map' ); | ||
| var acoshf = require( '@stdlib/math/base/special/fast/acoshf' ); | ||
|
|
||
| var opts = { | ||
| 'dtype': 'float32' | ||
| }; | ||
| var x = uniform( 103, 1.0, 5.0, opts ); | ||
|
|
||
| logEachMap( 'acoshf(%0.4f) = %0.4f', x, acoshf ); | ||
| ``` | ||
|
|
||
| </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/acoshf.h" | ||
| ``` | ||
|
|
||
| #### stdlib_base_fast_acoshf( x ) | ||
|
|
||
| Computes the [hyperbolic arccosine][inverse-hyperbolic] of a single-precision floating-point number. | ||
|
|
||
| ```c | ||
| float out = stdlib_base_fast_acoshf( 1.0f ); | ||
| // returns 0.0 | ||
|
|
||
| out = stdlib_base_fast_acoshf( 2.0f ); | ||
| // returns ~1.317 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **x**: `[in] float` input value. | ||
|
|
||
| ```c | ||
| float stdlib_base_fast_acoshf( const float x ); | ||
| ``` | ||
|
|
||
| </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/acoshf.h" | ||
| #include <stdlib.h> | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| float x; | ||
| float v; | ||
| int i; | ||
|
|
||
| for ( i = 0; i < 100; i++ ) { | ||
| x = ( (float)rand() / (float)RAND_MAX ) * 100.0f; | ||
| v = stdlib_base_fast_acoshf( x ); | ||
| printf( "acoshf(%f) = %f\n", x, v ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- 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"> | ||
|
|
||
| [inverse-hyperbolic]: https://en.wikipedia.org/wiki/Inverse_hyperbolic_function | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
55 changes: 55 additions & 0 deletions
55
lib/node_modules/@stdlib/math/base/special/fast/acoshf/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,55 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 acoshf = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var x; | ||
| var y; | ||
| var i; | ||
|
|
||
| x = uniform( 100, 1.0, 100.0, { | ||
| 'dtype': 'float32' | ||
| }); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = acoshf( x[ i%x.length ] ); | ||
| if ( isnanf( y ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnanf( y ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } else { | ||
| b.pass( 'benchmark finished' ); | ||
| } | ||
| b.end(); | ||
| }); |
65 changes: 65 additions & 0 deletions
65
lib/node_modules/@stdlib/math/base/special/fast/acoshf/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,65 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var acoshf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
| var opts = { | ||
| 'skip': ( acoshf instanceof Error ) | ||
| }; | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( format( '%s::native', pkg ), opts, function benchmark( b ) { | ||
| var x; | ||
| var y; | ||
| var i; | ||
|
|
||
| x = uniform( 100, 1.0, 100.0, { | ||
| 'dtype': 'float32' | ||
| }); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = acoshf( x[ i%x.length ] ); | ||
| if ( isnanf( y ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnanf( y ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } else { | ||
| 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.