Skip to content

Commit f1cbc3a

Browse files
anandkaranubcstdlib-bot
anandkaranubc
and
stdlib-bot
authored
feat: add math/base/special/cosm1f
PR-URL: #7371 Ref: #649 Co-authored-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Karan Anand <[email protected]>
1 parent b8eaf74 commit f1cbc3a

File tree

28 files changed

+2019
-0
lines changed

28 files changed

+2019
-0
lines changed

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

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

‎lib/node_modules/@stdlib/math/base/special/cosm1f/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 cosm1f = 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 = cosm1f( 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/cosm1f/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 cosm1f = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( cosm1f 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 = cosm1f( 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)