Skip to content

Commit 50b38f9

Browse files
gunjjoshigunjjoshi
authored
feat: add math/base/special/acotdf
PR-URL: #2799 Ref: #649 Reviewed-by: Athan Reines <[email protected]>
1 parent 15878f9 commit 50b38f9

File tree

28 files changed

+1906
-0
lines changed

28 files changed

+1906
-0
lines changed

‎lib/node_modules/@stdlib/math/base/special/acotdf/README.md

+174
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# acotdf
22+
23+
> Compute the [arccotangent][arccotangent] in degrees of a single-precision floating-point number.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var acotdf = require( '@stdlib/math/base/special/acotdf' );
31+
```
32+
33+
#### acotdf( x )
34+
35+
Computes the [arccotangent][arccotangent] (in degrees) of a single-precision floating-point number.
36+
37+
```javascript
38+
var sqrtf = require( '@stdlib/math/base/special/sqrtf' );
39+
40+
var v = acotdf( 0.0 );
41+
// returns 90.0
42+
43+
v = acotdf( sqrtf( 3.0 ) );
44+
// returns ~30.0
45+
46+
v = acotdf( 1.0 );
47+
// returns 45.0
48+
49+
v = acotdf( sqrtf( 3.0 ) / 3.0 );
50+
// returns ~60.0
51+
52+
v = acotdf( NaN );
53+
// returns NaN
54+
```
55+
56+
</section>
57+
58+
<!-- /.usage -->
59+
60+
<section class="examples">
61+
62+
## Examples
63+
64+
<!-- eslint no-undef: "error" -->
65+
66+
```javascript
67+
var linspace = require( '@stdlib/array/base/linspace' );
68+
var acotdf = require( '@stdlib/math/base/special/acotdf' );
69+
70+
var x = linspace( -1.0, 1.0, 100 );
71+
72+
var i;
73+
for ( i = 0; i < x.length; i++ ) {
74+
console.log( acotdf( x[ i ] ) );
75+
}
76+
```
77+
78+
</section>
79+
80+
<!-- /.examples -->
81+
82+
<!-- C usage documentation. -->
83+
84+
<section class="usage">
85+
86+
### Usage
87+
88+
```c
89+
#include "stdlib/math/base/special/acotdf.h"
90+
```
91+
92+
#### stdlib_base_acotdf( x )
93+
94+
Computes the [arccotangent][arccotangent] (in degrees) of a single-precision floating-point number.
95+
96+
```c
97+
float out = stdlib_base_acotdf( 0.0f );
98+
// returns 90.0f
99+
100+
out = stdlib_base_acotdf( 3.0f );
101+
// returns ~30.0f
102+
```
103+
104+
The function accepts the following arguments:
105+
106+
- **x**: `[in] float` input value.
107+
108+
```c
109+
float stdlib_base_acotdf( const float x );
110+
```
111+
112+
</section>
113+
114+
<!-- /.usage -->
115+
116+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
117+
118+
<section class="notes">
119+
120+
</section>
121+
122+
<!-- /.notes -->
123+
124+
<!-- C API usage examples. -->
125+
126+
<section class="examples">
127+
128+
### Examples
129+
130+
```c
131+
#include "stdlib/math/base/special/acotdf.h"
132+
#include <stdio.h>
133+
134+
int main( void ) {
135+
const float x[] = { 1.0f, 1.45f, 1.89f, 2.33f, 2.78f, 3.22f, 3.66f, 4.11f, 4.55f, 5.0f };
136+
137+
float v;
138+
int i;
139+
for ( i = 0; i < 10; i++ ) {
140+
v = stdlib_base_acotdf( x[ i ] );
141+
printf( "acotdf(%f) = %f\n", x[ i ], v );
142+
}
143+
}
144+
```
145+
146+
</section>
147+
148+
<!-- /.examples -->
149+
150+
</section>
151+
152+
<!-- /.c -->
153+
154+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
155+
156+
<section class="related">
157+
158+
</section>
159+
160+
<!-- /.related -->
161+
162+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
163+
164+
<section class="links">
165+
166+
[arccotangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
167+
168+
<!-- <related-links> -->
169+
170+
<!-- </related-links> -->
171+
172+
</section>
173+
174+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/acotdf/benchmark/benchmark.js

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/array/uniform' );
25+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var pkg = require( './../package.json' ).name;
27+
var acotdf = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var x;
34+
var y;
35+
var i;
36+
37+
x = randu( 100, -100.0, 100.0 );
38+
39+
b.tic();
40+
for ( i = 0; i < b.iterations; i++ ) {
41+
y = acotdf( x[ i % x.length ] );
42+
if ( isnanf( y ) ) {
43+
b.fail( 'should not return NaN' );
44+
}
45+
}
46+
b.toc();
47+
if ( isnanf( y ) ) {
48+
b.fail( 'should not return NaN' );
49+
}
50+
b.pass( 'benchmark finished' );
51+
b.end();
52+
});

‎lib/node_modules/@stdlib/math/base/special/acotdf/benchmark/benchmark.native.js

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/array/uniform' );
26+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var pkg = require( './../package.json' ).name;
29+
30+
31+
// VARIABLES //
32+
33+
var acotdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( acotdf instanceof Error )
36+
};
37+
38+
39+
// MAIN //
40+
41+
bench( pkg+'::native', opts, function benchmark( b ) {
42+
var x;
43+
var y;
44+
var i;
45+
46+
x = randu( 100, -100.0, 100.0 );
47+
48+
b.tic();
49+
for ( i = 0; i < b.iterations; i++ ) {
50+
y = acotdf( x[ i % x.length ] );
51+
if ( isnanf( y ) ) {
52+
b.fail( 'should not return NaN' );
53+
}
54+
}
55+
b.toc();
56+
if ( isnanf( y ) ) {
57+
b.fail( 'should not return NaN' );
58+
}
59+
b.pass( 'benchmark finished' );
60+
b.end();
61+
});

0 commit comments

Comments
 (0)