Skip to content

Commit fe2d39b

Browse files
gunjjoshigunjjoshi
committed
feat: add C implementation for @stdlib/math/base/special/ellipe
This commit introduces a C implementation for the elliptic integral of the second kind (@stdlib/math/base/special/ellipe).
1 parent 615bcf1 commit fe2d39b

File tree

32 files changed

+1898
-190
lines changed

32 files changed

+1898
-190
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2019 The Stdlib Authors.
5+
Copyright (c) 2024 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.

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

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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 ellipe = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( ellipe instanceof Error )
36+
};
37+
38+
39+
// MAIN //
40+
41+
bench( pkg+'::native', opts, function benchmark( b ) {
42+
var y;
43+
var i;
44+
45+
b.tic();
46+
for ( i = 0; i < b.iterations; i++ ) {
47+
y = ellipe( randu() );
48+
if ( isnan( y ) ) {
49+
b.fail( 'should not return NaN' );
50+
}
51+
}
52+
b.toc();
53+
if ( isnan( y ) ) {
54+
b.fail( 'should not return NaN' );
55+
}
56+
b.pass( 'benchmark finished' );
57+
b.end();
58+
});

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

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) 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

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

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
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+
/**
20+
* Benchmark `ellipe`.
21+
*/
22+
#include "stdlib/math/base/special/ellipe.h"
23+
#include <stdlib.h>
24+
#include <stdio.h>
25+
#include <math.h>
26+
#include <time.h>
27+
#include <sys/time.h>
28+
29+
#define NAME "ellipe"
30+
#define ITERATIONS 1000000
31+
#define REPEATS 3
32+
33+
/**
34+
* Prints the TAP version.
35+
*/
36+
void print_version() {
37+
printf( "TAP version 13\n" );
38+
}
39+
40+
/**
41+
* Prints the TAP summary.
42+
*
43+
* @param total total number of tests
44+
* @param passing total number of passing tests
45+
*/
46+
void print_summary( int total, int passing ) {
47+
printf( "#\n" );
48+
printf( "1..%d\n", total ); // TAP plan
49+
printf( "# total %d\n", total );
50+
printf( "# pass %d\n", passing );
51+
printf( "#\n" );
52+
printf( "# ok\n" );
53+
}
54+
55+
/**
56+
* Prints benchmarks results.
57+
*
58+
* @param elapsed elapsed time in seconds
59+
*/
60+
void print_results( double elapsed ) {
61+
double rate = (double)ITERATIONS / elapsed;
62+
printf( " ---\n" );
63+
printf( " iterations: %d\n", ITERATIONS );
64+
printf( " elapsed: %0.9f\n", elapsed );
65+
printf( " rate: %0.9f\n", rate );
66+
printf( " ...\n" );
67+
}
68+
69+
/**
70+
* Returns a clock time.
71+
*
72+
* @return clock time
73+
*/
74+
double tic() {
75+
struct timeval now;
76+
gettimeofday( &now, NULL );
77+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
78+
}
79+
80+
/**
81+
* Generates a random number on the interval [0,1].
82+
*
83+
* @return random number
84+
*/
85+
double rand_double() {
86+
int r = rand();
87+
return (double)r / ( (double)RAND_MAX + 1.0 );
88+
}
89+
90+
/**
91+
* Runs a benchmark.
92+
*
93+
* @return elapsed time in seconds
94+
*/
95+
double benchmark() {
96+
double elapsed;
97+
double x;
98+
double y;
99+
double t;
100+
int i;
101+
102+
t = tic();
103+
for ( i = 0; i < ITERATIONS; i++ ) {
104+
x = rand_double();
105+
y = stdlib_base_ellipe( x );
106+
if ( y != y ) {
107+
printf( "should not return NaN\n" );
108+
break;
109+
}
110+
}
111+
elapsed = tic() - t;
112+
if ( y != y ) {
113+
printf( "should not return NaN\n" );
114+
}
115+
return elapsed;
116+
}
117+
118+
/**
119+
* Main execution sequence.
120+
*/
121+
int main( void ) {
122+
double elapsed;
123+
int i;
124+
125+
// Use the current time to seed the random number generator:
126+
srand( time( NULL ) );
127+
128+
print_version();
129+
for ( i = 0; i < REPEATS; i++ ) {
130+
printf( "# c::native::%s\n", NAME );
131+
elapsed = benchmark();
132+
print_results( elapsed );
133+
printf( "ok %d benchmark finished\n", i+1 );
134+
}
135+
print_summary( REPEATS, REPEATS );
136+
}

0 commit comments

Comments
 (0)