Skip to content

Commit 4ca9916

Browse files
authored
feat!: migrate to using stdlib complex number types
In addition to migrating to use stdlib complex number types, this commit adds an addon interface to allow testing the C implementation from JavaScript. BREAKING CHANGE: migrate to using stdlib complex number types To migrate, users need to change `double complex` to `stdlib_complex128_t`. PR-URL: #916 Reviewed-by: Athan Reines <kgryte@gmail.com> Private-ref: stdlib-js/todo#1454
1 parent 119e99d commit 4ca9916

File tree

17 files changed

+969
-65
lines changed

17 files changed

+969
-65
lines changed

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

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,27 @@ for ( i = 0; i < 100; i++ ) {
109109
Rounds a double-precision complex floating-point number toward positive infinity.
110110

111111
```c
112-
#include <complex.h>
112+
#include "stdlib/complex/float64.h"
113+
#include "stdlib/complex/real.h"
114+
#include "stdlib/complex/imag.h"
113115

114-
double complex y = stdlib_base_cceil( 2.5-1.5*I );
115-
// returns 3.0-1.0*I
116+
stdlib_complex128_t z = stdlib_complex128( 2.5, -1.5 );
117+
118+
stdlib_complex128_t out = stdlib_base_cceil( z );
119+
120+
double re = stdlib_real( out );
121+
// returns 3.0
122+
123+
double im = stdlib_imag( out );
124+
// returns -1.0
116125
```
117126

118127
The function accepts the following arguments:
119128

120-
- **z**: `[in] double complex` input value.
129+
- **z**: `[in] stdlib_complex128_t` input value.
121130

122131
```c
123-
double complex stdlib_base_cceil( const double complex z );
132+
stdlib_complex128_t stdlib_base_cceil( const stdlib_complex128_t z );
124133
```
125134
126135
</section>
@@ -143,19 +152,31 @@ double complex stdlib_base_cceil( const double complex z );
143152
144153
```c
145154
#include "stdlib/math/base/special/cceil.h"
155+
#include "stdlib/complex/float64.h"
156+
#include "stdlib/complex/reim.h"
146157
#include <stdio.h>
147-
#include <complex.h>
148158
149159
int main() {
150-
double complex x[] = { 3.14+1.5*I, -3.14-1.5*I, 0.0+0.0*I, 0.0/0.0+0.0/0.0*I };
151-
152-
double complex v;
153-
double complex y;
160+
const stdlib_complex128_t x[] = {
161+
stdlib_complex128( 3.14, 1.5 ),
162+
stdlib_complex128( -3.14, -1.5 ),
163+
stdlib_complex128( 0.0, 0.0 ),
164+
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
165+
};
166+
167+
stdlib_complex128_t v;
168+
stdlib_complex128_t y;
169+
double re1;
170+
double im1;
171+
double re2;
172+
double im2;
154173
int i;
155174
for ( i = 0; i < 4; i++ ) {
156175
v = x[ i ];
157176
y = stdlib_base_cceil( v );
158-
printf( "cceil(%lf + %lfi) = %lf + %lfi\n", creal( v ), cimag( v ), creal( y ), cimag( y ) );
177+
stdlib_reim( v, &re1, &im1 );
178+
stdlib_reim( y, &re2, &im2 );
179+
printf( "cceil(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
159180
}
160181
}
161182
```
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 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/base/uniform' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var Complex128 = require( '@stdlib/complex/float64' );
28+
var real = require( '@stdlib/complex/real' );
29+
var tryRequire = require( '@stdlib/utils/try-require' );
30+
var pkg = require( './../package.json' ).name;
31+
32+
33+
// VARIABLES //
34+
35+
var cceil = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( cceil instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg+'::native', opts, function benchmark( b ) {
44+
var values;
45+
var y;
46+
var i;
47+
48+
values = [
49+
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ),
50+
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) )
51+
];
52+
53+
b.tic();
54+
for ( i = 0; i < b.iterations; i++ ) {
55+
y = cceil( values[ i%values.length ] );
56+
if ( isnan( real( y ) ) ) {
57+
b.fail( 'should not return NaN' );
58+
}
59+
}
60+
b.toc();
61+
if ( isnan( real( y ) ) ) {
62+
b.fail( 'should not return NaN' );
63+
}
64+
b.pass( 'benchmark finished' );
65+
b.end();
66+
});

lib/node_modules/@stdlib/math/base/special/cceil/benchmark/c/Makefile

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -69,34 +69,18 @@ else
6969
fPIC ?= -fPIC
7070
endif
7171

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-
8472
# List of C targets:
8573
c_targets := benchmark.out
8674

8775

8876
# RULES #
8977

9078
#/
91-
# Compiles source files.
79+
# Compiles C source files.
9280
#
9381
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
9482
# @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`)
83+
# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code (e.g., `-fPIC`)
10084
#
10185
# @example
10286
# make
@@ -112,16 +96,12 @@ all: $(c_targets)
11296
# Compiles C source files.
11397
#
11498
# @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`)
99+
# @param {string} CC - C compiler
100+
# @param {string} CFLAGS - C compiler flags
101+
# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code
122102
#/
123103
$(c_targets): %.out: %.c
124-
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
104+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm
125105

126106
#/
127107
# Runs compiled benchmarks.

lib/node_modules/@stdlib/math/base/special/cceil/benchmark/c/benchmark.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
/**
2020
* Benchmark `cceil`.
2121
*/
22-
#include "stdlib/math/base/special/cceil.h"
22+
#include "stdlib/math/base/special/ceil.h"
2323
#include <complex.h>
2424
#include <stdlib.h>
2525
#include <stdio.h>
@@ -105,7 +105,7 @@ double benchmark() {
105105
for ( i = 0; i < ITERATIONS; i++ ) {
106106
v = ( 1000.0*rand_double() ) - 500.0;
107107
x = v + v*I;
108-
y = stdlib_base_cceil( x );
108+
y = stdlib_base_ceil( creal( x ) ) + stdlib_base_ceil( cimag( x ) )*I;
109109
if ( creal( y ) != creal( y ) ) {
110110
printf( "unexpected result\n" );
111111
break;
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2021 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)