Skip to content

Commit 0b633eb

Browse files
gunjjoshiPlaneshifterkgryte
authored
feat: add C implementation for math/base/special/rempio2
PR-URL: #2279 Ref: #649 --------- Signed-off-by: GUNJ JOSHI <[email protected]> Signed-off-by: Athan Reines <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent bd06c4d commit 0b633eb

File tree

17 files changed

+2220
-51
lines changed

17 files changed

+2220
-51
lines changed

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

+102-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var rempio2 = require( '@stdlib/math/base/special/rempio2' );
3232

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

35-
Computes `x - nπ/2 = r`. The function returns `n` and stores the remainder `r` as two numbers in `y`, such that `y[0]+y[1] = r`.
35+
Computes `x - nπ/2 = r`.
3636

3737
```javascript
3838
var y = [ 0.0, 0.0 ];
@@ -46,7 +46,7 @@ var y2 = y[ 1 ];
4646
// returns ~3.618e-17
4747
```
4848

49-
When `x` is `NaN` or infinite, the function returns zero and sets the elements of `y` to `NaN`.
49+
When `x` is `NaN` or infinite, the function returns `0` and sets the elements of `y` to `NaN`.
5050

5151
```javascript
5252
var y = [ 0.0, 0.0 ];
@@ -80,6 +80,7 @@ y2 = y[ 1 ];
8080

8181
## Notes
8282

83+
- The function returns `n` and stores the remainder `r` as two numbers in `y`, such that `y[0]+y[1] = r`.
8384
- For input values larger than `2^20*π/2` in magnitude, the function **only** returns the last three binary digits of `n` and not the full result.
8485

8586
</section>
@@ -111,6 +112,105 @@ for ( i = 0; i < x.length; i++ ) {
111112

112113
<!-- /.examples -->
113114

115+
<!-- C interface documentation. -->
116+
117+
* * *
118+
119+
<section class="c">
120+
121+
## C APIs
122+
123+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
124+
125+
<section class="intro">
126+
127+
</section>
128+
129+
<!-- /.intro -->
130+
131+
<!-- C usage documentation. -->
132+
133+
<section class="usage">
134+
135+
### Usage
136+
137+
```c
138+
#include "stdlib/math/base/special/rempio2.h"
139+
```
140+
141+
#### stdlib_base_rempio2( x, &rem1, &rem2 )
142+
143+
Computes `x - nπ/2 = r`.
144+
145+
```c
146+
#include <stdint.h>
147+
148+
double rem1;
149+
double rem2;
150+
151+
int32_t n = stdlib_base_rempio2( 4.0, &rem1, &rem2 );
152+
```
153+
154+
The function accepts the following arguments:
155+
156+
- **x**: `[in] double` input value.
157+
- **rem1**: `[out] double*` destination for first remainder number.
158+
- **rem2**: `[out] double*` destination for second remainder number.
159+
160+
```c
161+
int32_t stdlib_base_rempio2( const double x, double *rem1, double *rem2 );
162+
```
163+
164+
</section>
165+
166+
<!-- /.usage -->
167+
168+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
169+
170+
<section class="notes">
171+
172+
### Notes
173+
174+
- The function returns `n` and stores the remainder `r` as two numbers in `rem1` and `rem2`, respectively, such that `rem1+rem2 = r`.
175+
176+
</section>
177+
178+
<!-- /.notes -->
179+
180+
<!-- C API usage examples. -->
181+
182+
<section class="examples">
183+
184+
### Examples
185+
186+
```c
187+
#include "stdlib/math/base/special/rempio2.h"
188+
#include <stdio.h>
189+
#include <stdint.h>
190+
#include <inttypes.h>
191+
192+
int main( void ) {
193+
const double x[] = { 0.0, 1.0, 4.0, 128.0 };
194+
195+
double rem1;
196+
double rem2;
197+
int32_t n;
198+
int i;
199+
for ( i = 0; i < 4; i++ ) {
200+
n = stdlib_base_rempio2( x[ i ], &rem1, &rem2 );
201+
printf( "%lf - %"PRId32"π/2 = %lf + %lf\n", x[ i ], n, rem1, rem2 );
202+
}
203+
}
204+
```
205+
206+
</section>
207+
208+
<!-- /.examples -->
209+
210+
</section>
211+
212+
<!-- /.c -->
213+
114214
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
115215

116216
<section class="related">

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

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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/base/randu' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var pkg = require( './../package.json' ).name;
29+
30+
31+
// VARIABLES //
32+
33+
var rempio2 = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( rempio2 instanceof Error )
36+
};
37+
38+
39+
// MAIN //
40+
41+
bench( pkg+'::native', opts, function benchmark( b ) {
42+
var x;
43+
var y;
44+
var n;
45+
var i;
46+
47+
y = [ 0.0, 0.0 ];
48+
49+
b.tic();
50+
for ( i = 0; i < b.iterations; i++ ) {
51+
x = ( randu() * 200.0 ) - 100.0;
52+
n = rempio2( x, y );
53+
if ( isnan( n ) ) {
54+
b.fail( 'should not return NaN' );
55+
}
56+
}
57+
b.toc();
58+
if ( isnan( n ) || isnan( y[0] ) || isnan( y[1] ) ) {
59+
b.fail( 'should not return NaN' );
60+
}
61+
b.pass( 'benchmark finished' );
62+
b.end();
63+
});

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

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
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+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

0 commit comments

Comments
 (0)