Skip to content

Commit ecda47c

Browse files
chore: clean up
1 parent c4e6ad7 commit ecda47c

File tree

25 files changed

+237
-221
lines changed

25 files changed

+237
-221
lines changed

lib/node_modules/@stdlib/math/base/special/atan2f/README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2024 The Stdlib Authors.
5+
Copyright (c) 2025 The Stdlib Authors.
66
77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# atan2f
2222

23-
> Compute the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
23+
> Compute the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)` for single-precision floating-point number.
2424
2525
<section class="usage">
2626

@@ -32,13 +32,13 @@ var atan2f = require( '@stdlib/math/base/special/atan2f' );
3232

3333
#### atan2f( y, x )
3434

35-
Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
35+
Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)` for single-precision floating-point number.
3636

3737
```javascript
3838
var v = atan2f( 2.0, 2.0 ); // => atanf(1.0)
3939
// returns ~0.785
4040

41-
v = atanf2( 6.0, 2.0 ); // => atanf(3.0)
41+
v = atan2f( 6.0, 2.0 ); // => atanf(3.0)
4242
// returns ~1.249
4343

4444
v = atan2f( -1.0, -1.0 ); // => atanf(1.0) - π
@@ -114,14 +114,11 @@ for ( i = 0; i < 100; i++ ) {
114114

115115
#### stdlib_base_atan2f( y, x )
116116

117-
Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
117+
Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)` for single-precision floating-point number.
118118

119119
```c
120-
float out = stdlib_base_atan2f( 2.0,f 2.0f );
120+
float out = stdlib_base_atan2f( 2.0,f 2.0f );
121121
// returns ~0.785f
122-
123-
out = stdlib_base_atan2f( 6.0f, 2.0f );
124-
// returns ~1.249f
125122
```
126123

127124
The function accepts the following arguments:
@@ -188,8 +185,8 @@ int main( void ) {
188185

189186
## See Also
190187

191-
- <span class="package-name">[`@stdlib/math/base/special/atan`][@stdlib/math/base/special/atan]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a single-precision floating-point number.</span>
192-
188+
- <span class="package-name">[`@stdlib/math/base/special/atanf`][@stdlib/math/base/special/atanf]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a single-precision floating-point number.</span>
189+
- <span class="package-name">[`@stdlib/math/base/special/atan2`][@stdlib/math/base/special/atan2]</span><span class="delimiter">: </span><span class="description">compute the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y).</span>
193190
</section>
194191

195192
<!-- /.related -->
@@ -200,7 +197,9 @@ int main( void ) {
200197

201198
<!-- <related-links> -->
202199

203-
[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan
200+
[@stdlib/math/base/special/atanf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanf
201+
202+
[@stdlib/math/base/special/atan2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan2
204203

205204
<!-- </related-links> -->
206205

lib/node_modules/@stdlib/math/base/special/atan2f/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2024 The Stdlib Authors.
4+
* Copyright (c) 2025 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2024 The Stdlib Authors.
4+
* Copyright (c) 2025 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.

lib/node_modules/@stdlib/math/base/special/atan2f/benchmark/c/native/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#/
22
# @license Apache-2.0
33
#
4-
# Copyright (c) 2024 The Stdlib Authors.
4+
# Copyright (c) 2025 The Stdlib Authors.
55
#
66
# Licensed under the Apache License, Version 2.0 (the "License");
77
# you may not use this file except in compliance with the License.

lib/node_modules/@stdlib/math/base/special/atan2f/benchmark/c/native/benchmark.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2024 The Stdlib Authors.
4+
* Copyright (c) 2025 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19+
#include "stdlib/math/base/special/atan2f.h"
1920
#include <stdlib.h>
2021
#include <stdio.h>
2122
#include <math.h>
@@ -100,7 +101,7 @@ static double benchmark( void ) {
100101
for ( i = 0; i < ITERATIONS; i++ ) {
101102
x = ( 100.0f*rand_float() ) - 0.0f;
102103
y = ( 100.0f*rand_float() ) - 0.0f;
103-
z = atan2f( x, y );
104+
z = stdlib_base_atan2f( x, y );
104105
if ( z != z ) {
105106
printf( "should not return NaN\n" );
106107
break;

lib/node_modules/@stdlib/math/base/special/atan2f/binding.gyp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @license Apache-2.0
22
#
3-
# Copyright (c) 2024 The Stdlib Authors.
3+
# Copyright (c) 2025 The Stdlib Authors.
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.

lib/node_modules/@stdlib/math/base/special/atan2f/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( y, x )
33
Computes the angle in the plane (in radians) between the positive x-axis and
4-
the ray from (0,0) to the point (x,y).
4+
the ray from (0,0) to the point (x,y) for single-precision floating-point number.
55

66
Parameters
77
----------

lib/node_modules/@stdlib/math/base/special/atan2f/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2024 The Stdlib Authors.
4+
* Copyright (c) 2025 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
22+
* Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)` for single-precision floating-point number.
2323
*
2424
* @param y - `y` coordinate
2525
* @param x - `x` coordinate

lib/node_modules/@stdlib/math/base/special/atan2f/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2024 The Stdlib Authors.
4+
* Copyright (c) 2025 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.

lib/node_modules/@stdlib/math/base/special/atan2f/examples/c/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#/
22
# @license Apache-2.0
33
#
4-
# Copyright (c) 2024 The Stdlib Authors.
4+
# Copyright (c) 2025 The Stdlib Authors.
55
#
66
# Licensed under the Apache License, Version 2.0 (the "License");
77
# you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)