Skip to content

Commit 80100df

Browse files
Neerajpathak07Neerajpathak07
committed
feat: basic setup
1 parent b1efabf commit 80100df

File tree

5 files changed

+594
-0
lines changed

5 files changed

+594
-0
lines changed

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

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
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+
# atan2f
22+
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)`.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var atan2f = require( '@stdlib/math/base/special/atan2f' );
31+
```
32+
33+
#### atan2f( y, x )
34+
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)`.
36+
37+
```javascript
38+
var v = atan2f( 2.0, 2.0 ); // => atanf(1.0)
39+
// returns ~0.785
40+
41+
v = atan2f( 6.0, 2.0 ); // => atanf(3.0)
42+
// returns ~1.249
43+
44+
v = atan2f( -1.0, -1.0); // => atanf(1.0) - π
45+
// returns ~-2.356
46+
47+
v = atan2f( 3.0, 0.0 ); // => π/2
48+
// returns ~1.571
49+
50+
v = atan2f( -2.0, 0.0 ); // => -π/2
51+
// returns ~-1.571
52+
53+
v = atan2f( 0.0, 0.0 );
54+
// returns 0.0
55+
56+
v = atan2f( 3.0, NaN );
57+
// returns NaN
58+
```
59+
60+
</section>
61+
62+
<!-- /.usage -->
63+
64+
<section class="examples">
65+
66+
## Examples
67+
68+
<!-- eslint no-undef: "error" -->
69+
70+
```javascript
71+
var randu = require( '@stdlib/random/base/randu' );
72+
var atan2f = require( '@stdlib/math/base/special/atan2f' );
73+
74+
var y;
75+
var x;
76+
var i;
77+
78+
for ( i = 0; i < 100; i++ ) {
79+
y = randu() * 100.0;
80+
x = randu() * 100.0;
81+
console.log( 'y: %d, \t x: %d, \t atan2f(y,x): %d', y.toFixed( 4 ), x.toFixed( 4 ), atan2f( y, x ).toFixed( 4 ) );
82+
}
83+
```
84+
85+
</section>
86+
87+
<!-- /.examples -->
88+
89+
<!-- C interface documentation. -->
90+
91+
* * *
92+
93+
<section class="c">
94+
95+
## C APIs
96+
97+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
98+
99+
<section class="intro">
100+
101+
</section>
102+
103+
<!-- /.intro -->
104+
105+
<!-- C usage documentation. -->
106+
107+
<section class="usage">
108+
109+
### Usage
110+
111+
```c
112+
#include "stdlib/math/base/special/atan2f.h"
113+
```
114+
115+
#### stdlib_base_atan2f( y, x )
116+
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)`.
118+
119+
```c
120+
float out = stdlib_base_atan2f( 2.0f, 2.0f );
121+
// returns ~0.785f
122+
123+
out = stdlib_base_atan2f( 6.0f, 2.0f );
124+
// returns ~1.249f
125+
```
126+
127+
The function accepts the following arguments:
128+
129+
- **y**: `[in] float` - `y` coordinate
130+
- **x**: `[in] float` - `x` coordinate
131+
132+
```c
133+
float stdlib_base_atan2f( const float y, const float x );
134+
```
135+
136+
</section>
137+
138+
<!-- /.usage -->
139+
140+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
141+
142+
<section class="notes">
143+
144+
</section>
145+
146+
<!-- /.notes -->
147+
148+
<!-- C API usage examples. -->
149+
150+
<section class="examples">
151+
152+
### Examples
153+
154+
```c
155+
#include "stdlib/math/base/special/atan2f.h"
156+
#include <stdlib.h>
157+
#include <stdio.h>
158+
159+
int main( void ) {
160+
float y;
161+
float x;
162+
float v;
163+
int i;
164+
165+
for ( i = 0; i < 100; i++ ) {
166+
y = ( ( (float)rand() / (float)RAND_MAX ) * 100.0 );
167+
x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0 );
168+
v = stdlib_base_atan2f( y, x );
169+
printf( "atan2f(%f, %f) = %f\n", y, x, v );
170+
}
171+
return 0;
172+
}
173+
```
174+
175+
</section>
176+
177+
<!-- /.examples -->
178+
179+
</section>
180+
181+
<!-- /.c -->
182+
183+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
184+
185+
<section class="related">
186+
187+
* * *
188+
189+
## See Also
190+
191+
- <span class="package-name">[`@stdlib/math/base/special/atan2`][@stdlib/math/base/special/atan]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a double-precision floating-point number.</span>
192+
193+
</section>
194+
195+
<!-- /.related -->
196+
197+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
198+
199+
<section class="links">
200+
201+
<!-- <related-links> -->
202+
203+
[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan2
204+
205+
<!-- </related-links> -->
206+
207+
</section>
208+
209+
<!-- /.links -->

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

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
# @license Apache-2.0
2+
#
3+
# Copyright (c) 2024 The Stdlib Authors.
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
# A `.gyp` file for building a Node.js native add-on.
18+
#
19+
# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
20+
# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
21+
{
22+
# List of files to include in this file:
23+
'includes': [
24+
'./include.gypi',
25+
],
26+
27+
# Define variables to be used throughout the configuration for all targets:
28+
'variables': {
29+
# Target name should match the add-on export name:
30+
'addon_target_name%': 'addon',
31+
32+
# Set variables based on the host OS:
33+
'conditions': [
34+
[
35+
'OS=="win"',
36+
{
37+
# Define the object file suffix:
38+
'obj': 'obj',
39+
},
40+
{
41+
# Define the object file suffix:
42+
'obj': 'o',
43+
}
44+
], # end condition (OS=="win")
45+
], # end conditions
46+
}, # end variables
47+
48+
# Define compile targets:
49+
'targets': [
50+
51+
# Target to generate an add-on:
52+
{
53+
# The target name should match the add-on export name:
54+
'target_name': '<(addon_target_name)',
55+
56+
# Define dependencies:
57+
'dependencies': [],
58+
59+
# Define directories which contain relevant include headers:
60+
'include_dirs': [
61+
# Local include directory:
62+
'<@(include_dirs)',
63+
],
64+
65+
# List of source files:
66+
'sources': [
67+
'<@(src_files)',
68+
],
69+
70+
# Settings which should be applied when a target's object files are used as linker input:
71+
'link_settings': {
72+
# Define libraries:
73+
'libraries': [
74+
'<@(libraries)',
75+
],
76+
77+
# Define library directories:
78+
'library_dirs': [
79+
'<@(library_dirs)',
80+
],
81+
},
82+
83+
# C/C++ compiler flags:
84+
'cflags': [
85+
# Enable commonly used warning options:
86+
'-Wall',
87+
88+
# Aggressive optimization:
89+
'-O3',
90+
],
91+
92+
# C specific compiler flags:
93+
'cflags_c': [
94+
# Specify the C standard to which a program is expected to conform:
95+
'-std=c99',
96+
],
97+
98+
# C++ specific compiler flags:
99+
'cflags_cpp': [
100+
# Specify the C++ standard to which a program is expected to conform:
101+
'-std=c++11',
102+
],
103+
104+
# Linker flags:
105+
'ldflags': [],
106+
107+
# Apply conditions based on the host OS:
108+
'conditions': [
109+
[
110+
'OS=="mac"',
111+
{
112+
# Linker flags:
113+
'ldflags': [
114+
'-undefined dynamic_lookup',
115+
'-Wl,-no-pie',
116+
'-Wl,-search_paths_first',
117+
],
118+
},
119+
], # end condition (OS=="mac")
120+
[
121+
'OS!="win"',
122+
{
123+
# C/C++ flags:
124+
'cflags': [
125+
# Generate platform-independent code:
126+
'-fPIC',
127+
],
128+
},
129+
], # end condition (OS!="win")
130+
], # end conditions
131+
}, # end target <(addon_target_name)
132+
133+
# Target to copy a generated add-on to a standard location:
134+
{
135+
'target_name': 'copy_addon',
136+
137+
# Declare that the output of this target is not linked:
138+
'type': 'none',
139+
140+
# Define dependencies:
141+
'dependencies': [
142+
# Require that the add-on be generated before building this target:
143+
'<(addon_target_name)',
144+
],
145+
146+
# Define a list of actions:
147+
'actions': [
148+
{
149+
'action_name': 'copy_addon',
150+
'message': 'Copying addon...',
151+
152+
# Explicitly list the inputs in the command-line invocation below:
153+
'inputs': [],
154+
155+
# Declare the expected outputs:
156+
'outputs': [
157+
'<(addon_output_dir)/<(addon_target_name).node',
158+
],
159+
160+
# Define the command-line invocation:
161+
'action': [
162+
'cp',
163+
'<(PRODUCT_DIR)/<(addon_target_name).node',
164+
'<(addon_output_dir)/<(addon_target_name).node',
165+
],
166+
},
167+
], # end actions
168+
}, # end target copy_addon
169+
], # end targets
170+
}

0 commit comments

Comments
 (0)