-
-
Notifications
You must be signed in to change notification settings - Fork 907
feat: add math/base/special/acosdf
#3015
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 10 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
8ef3c3b
feat: added readme and basic dependency files
aayush0325 7bb2ab5
feat: c files added
aayush0325 0297057
feat: main js functions added
aayush0325 5c6ddf5
feat: added tests
aayush0325 1a0329a
feat: added docs
aayush0325 036a74d
feat: added examples
aayush0325 a927074
feat: benchmark added
aayush0325 e3bad4c
fix: tests are updated for single precision floating point numbers
aayush0325 e0e3e18
fix: tests working now
aayush0325 0a92b55
fix: increased tolerance for single point precision numbers
aayush0325 fd79a0c
chore: changes from code review
aayush0325 b40d41a
chore: changes from code review
aayush0325 bf66332
fix: reverting wrong commit
aayush0325 4db54d0
chore: stuff from code review
aayush0325 fb45f8c
chore: stuff from code review
aayush0325 29c8ebd
chore: stuff from code review
aayush0325 ee4d4e3
Apply suggestions from code review
kgryte fcdad64
chore: code review
aayush0325 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
196 changes: 196 additions & 0 deletions
196
lib/node_modules/@stdlib/math/base/special/acosdf/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,196 @@ | ||
<!-- | ||
|
||
@license Apache-2.0 | ||
|
||
Copyright (c) 2024 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. | ||
|
||
--> | ||
|
||
# acosd | ||
|
||
> Compute the [arccosine][arccosine] in degrees of a single-precision floating-point number. | ||
Planeshifter marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var acosdf = require( '@stdlib/math/base/special/acosdf' ); | ||
``` | ||
|
||
#### acosdf( x ) | ||
|
||
Computes the [arccosine][arccosine] (in degrees) of a single-precision floating-point number. | ||
|
||
```javascript | ||
var sqrt = require( '@stdlib/math/base/special/sqrt' ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
var v = acosdf( 0.0 ); | ||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// returns 90.0 | ||
|
||
v = acosdf( 0.5 ); | ||
// returns ~60.0 | ||
|
||
v = acosdf( sqrt( 2 ) / 2 ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
// returns ~45.0 | ||
|
||
v = acosdf( sqrt( 3 ) / 2 ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
// returns ~30.0 | ||
|
||
v = acosdf( NaN ); | ||
// returns NaN | ||
``` | ||
|
||
The domain of `x` is restricted to `[-1,1]`. If `|x| > 1`, the function returns `NaN`. | ||
|
||
```javascript | ||
var v = acosdf( -3.14 ); | ||
// returns NaN | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var linspace = require( '@stdlib/array/base/linspace' ); | ||
var acosdf = require( '@stdlib/math/base/special/acosdf' ); | ||
|
||
var x = linspace( -1.0, 1.0, 100 ); | ||
|
||
var i; | ||
for ( i = 0; i < x.length; i++ ) { | ||
console.log( acosdf( x[ i ] ) ); | ||
} | ||
``` | ||
|
||
</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/acosdf.h" | ||
``` | ||
|
||
#### stdlib_base_acosdf( x ) | ||
|
||
Computes the [arccosine][arccosine] (in degrees) of a single-precision floating-point number. | ||
|
||
```c | ||
float out = stdlib_base_acosdf( 0.0 ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
// returns 90.0 | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
out = stdlib_base_acosdf( 0.5 ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
// returns ~60.0 | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
``` | ||
|
||
The function accepts the following arguments: | ||
|
||
- **x**: `[in] float` input value. | ||
|
||
```c | ||
float stdlib_base_acosdf( 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/acosdf.h" | ||
#include <stdio.h> | ||
|
||
int main( void ) { | ||
const float x[] = { 1.0f, 1.45f, 1.89f, 2.33f, 2.78f, 3.22f, 3.66f, 4.11f, 4.55f, 5.0f }; | ||
|
||
float v; | ||
int i; | ||
for ( i = 0; i < 10; i++ ) { | ||
v = stdlib_base_acosdf( x[ i ] ); | ||
printf( "acosdf(%f) = %f\n", x[ i ], 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"> | ||
|
||
[arccosine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions | ||
|
||
<!-- <related-links> --> | ||
|
||
<!-- </related-links> --> | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
51 changes: 51 additions & 0 deletions
51
lib/node_modules/@stdlib/math/base/special/acosdf/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,51 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2024 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 randu = require( '@stdlib/random/base/randu' ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
var pkg = require( './../package.json' ).name; | ||
var acosdf = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var x; | ||
var y; | ||
var i; | ||
|
||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
x = ( randu()*2.0 ) - 1.0; | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
y = acosdf( x ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
if ( isnanf( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnanf( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
60 changes: 60 additions & 0 deletions
60
lib/node_modules/@stdlib/math/base/special/acosdf/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,60 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2024 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 randu = require( '@stdlib/random/base/randu' ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var acosdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
var opts = { | ||
'skip': ( acosdf instanceof Error ) | ||
}; | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg+'::native', opts, function benchmark( b ) { | ||
var x; | ||
var y; | ||
var i; | ||
|
||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
x = ( randu() * 2.0 ) - 1.0; | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
y = acosdf( x ); | ||
aayush0325 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
if ( isnanf( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnanf( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
Oops, something went wrong.
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.