Skip to content

Commit 0da78b4

Browse files
anandkaranubcanandkaranubc
authored
feat: add math/base/special/cscf
PR-URL: #7341 Ref: #649 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 22c34fb commit 0da78b4

39 files changed

+2423
-0
lines changed

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

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# Cosecant
22+
23+
> Evaluate the [cosecant][trigonometric-functions] of a single-precision floating-point number (in radians).
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<section class="usage">
30+
31+
## Usage
32+
33+
```javascript
34+
var cscf = require( '@stdlib/math/base/special/cscf' );
35+
```
36+
37+
## cscf( x )
38+
39+
Evaluates the [cosecant][trigonometric-functions] of a single-precision floating-point number (in radians).
40+
41+
```javascript
42+
var v = cscf( 0.0 );
43+
// returns Infinity
44+
45+
v = cscf( 3.141592653589793/2.0 );
46+
// returns 1.0
47+
48+
v = cscf( -3.141592653589793/6.0 );
49+
// returns ~-2.0
50+
51+
v = cscf( 3.141592653589793/6.0 );
52+
// returns ~2.0
53+
54+
v = cscf( NaN );
55+
// returns NaN
56+
```
57+
58+
</section>
59+
60+
<!-- /.usage -->
61+
62+
<section class="examples">
63+
64+
## Examples
65+
66+
<!-- eslint no-undef: "error" -->
67+
68+
```javascript
69+
var uniform = require( '@stdlib/random/array/uniform' );
70+
var logEachMap = require( '@stdlib/console/log-each-map' );
71+
var TWO_PI = require( '@stdlib/constants/float32/two-pi' );
72+
var cscf = require( '@stdlib/math/base/special/cscf' );
73+
74+
var opts = {
75+
'dtype': 'float32'
76+
};
77+
var x = uniform( 100, 0.0, TWO_PI, opts );
78+
79+
logEachMap( 'cscf(%0.4f) = %0.4f', x, cscf );
80+
```
81+
82+
</section>
83+
84+
<!-- /.examples -->
85+
86+
<!-- C interface documentation. -->
87+
88+
* * *
89+
90+
<section class="c">
91+
92+
## C APIs
93+
94+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
95+
96+
<section class="intro">
97+
98+
</section>
99+
100+
<!-- /.intro -->
101+
102+
<!-- C usage documentation. -->
103+
104+
<section class="usage">
105+
106+
### Usage
107+
108+
```c
109+
#include "stdlib/math/base/special/cscf.h"
110+
```
111+
112+
#### stdlib_base_cscf( x )
113+
114+
Evaluates the [cosecant][trigonometric-functions] of a single-precision floating-point number (in radians).
115+
116+
```c
117+
float out = stdlib_base_cscf( 0.0f );
118+
// returns Infinity
119+
120+
out = stdlib_base_cscf( 3.141592653589793f / 2.0f );
121+
// returns 1.0f
122+
```
123+
124+
The function accepts the following arguments:
125+
126+
- **x**: `[in] float` input value.
127+
128+
```c
129+
float stdlib_base_cscf( const float x );
130+
```
131+
132+
</section>
133+
134+
<!-- /.usage -->
135+
136+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
137+
138+
<section class="notes">
139+
140+
</section>
141+
142+
<!-- /.notes -->
143+
144+
<!-- C API usage examples. -->
145+
146+
<section class="examples">
147+
148+
### Examples
149+
150+
```c
151+
#include "stdlib/math/base/special/cscf.h"
152+
#include <stdio.h>
153+
154+
int main( void ) {
155+
const float x[] = { 0.523f, 0.785f, 1.047f, 3.14f };
156+
157+
float y;
158+
int i;
159+
for ( i = 0; i < 4; i++ ) {
160+
y = stdlib_base_cscf( x[ i ] );
161+
printf( "cscf(%f) = %f\n", x[ i ], y );
162+
}
163+
}
164+
```
165+
166+
</section>
167+
168+
<!-- /.examples -->
169+
170+
</section>
171+
172+
<!-- /.c -->
173+
174+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
175+
176+
<section class="related">
177+
178+
</section>
179+
180+
<!-- /.related -->
181+
182+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
183+
184+
<section class="links">
185+
186+
[trigonometric-functions]: https://en.wikipedia.org/wiki/Trigonometric_functions
187+
188+
<!-- <related-links> -->
189+
190+
<!-- </related-links> -->
191+
192+
</section>
193+
194+
<!-- /.links -->

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 uniform = require( '@stdlib/random/array/uniform' );
25+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var pkg = require( './../package.json' ).name;
27+
var cscf = 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 = uniform( 100, -10.0, 10.0, {
38+
'dtype': 'float32'
39+
});
40+
41+
b.tic();
42+
for ( i = 0; i < b.iterations; i++ ) {
43+
y = cscf( x[ i%x.length ] );
44+
if ( isnanf( y ) ) {
45+
b.fail( 'should not return NaN' );
46+
}
47+
}
48+
b.toc();
49+
if ( isnanf( y ) ) {
50+
b.fail( 'should not return NaN' );
51+
}
52+
b.pass( 'benchmark finished' );
53+
b.end();
54+
});

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 uniform = 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 cscf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( cscf 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 = uniform( 100, -10.0, 10.0, {
47+
'dtype': 'float32'
48+
});
49+
50+
b.tic();
51+
for ( i = 0; i < b.iterations; i++ ) {
52+
y = cscf( x[ i%x.length ] );
53+
if ( isnanf( y ) ) {
54+
b.fail( 'should not return NaN' );
55+
}
56+
}
57+
b.toc();
58+
if ( isnanf( y ) ) {
59+
b.fail( 'should not return NaN' );
60+
}
61+
b.pass( 'benchmark finished' );
62+
b.end();
63+
});

0 commit comments

Comments
 (0)