Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add C implementation for math/base/special/ellipe #1452

Merged
merged 50 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from 48 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
fe2d39b
feat: add C implementation for @stdlib/math/base/special/ellipe
gunjjoshi Mar 2, 2024
c417c1e
feat: add C implementation for @stdlib/math/base/special/ellipe
gunjjoshi Mar 2, 2024
b747ddd
Update index.js
gunjjoshi Mar 3, 2024
1265c52
Update main.js
gunjjoshi Mar 3, 2024
cb4fe80
Update poly_p1.js
gunjjoshi Mar 3, 2024
0292a30
Update poly_p10.js
gunjjoshi Mar 3, 2024
305d517
Update poly_p11.js
gunjjoshi Mar 3, 2024
5e596d5
Update README.md
gunjjoshi Mar 3, 2024
32bec64
Update poly_p12.js
gunjjoshi Mar 3, 2024
7bfad01
Update poly_p9.js
gunjjoshi Mar 3, 2024
c9efb70
Update poly_p2.js
gunjjoshi Mar 3, 2024
b63002f
Update poly_p3.js
gunjjoshi Mar 3, 2024
e6fda42
Update poly_p4.js
gunjjoshi Mar 3, 2024
17b6c55
Update poly_p5.js
gunjjoshi Mar 3, 2024
1722c26
Update poly_p6.js
gunjjoshi Mar 3, 2024
232bf8e
Update poly_p7.js
gunjjoshi Mar 3, 2024
6d9f616
Update poly_p8.js
gunjjoshi Mar 3, 2024
c52374e
feat: add C implementation for @stdlib/math/base/special/ellipe
gunjjoshi Mar 3, 2024
95df2a4
Revert "feat: add C implementation for @stdlib/math/base/special/ellipe"
gunjjoshi Mar 3, 2024
9ea92bc
Update evalpoly.js
gunjjoshi Mar 3, 2024
f104040
Merge remote-tracking branch 'origin/ellipe-c' into ellipe-c
gunjjoshi Mar 3, 2024
7caf789
feat: add C implementation for @stdlib/math/base/special/ellipe
gunjjoshi Mar 3, 2024
aa6b465
Update README.md
gunjjoshi Mar 3, 2024
62dbbe9
Update README.md
gunjjoshi Mar 3, 2024
86be2c1
Update README.md
gunjjoshi Mar 3, 2024
8360e0c
Update include.gypi
gunjjoshi Mar 3, 2024
ec98fa2
Update lib/node_modules/@stdlib/math/base/special/ellipe/README.md
gunjjoshi Mar 3, 2024
71f3df9
Update ellipe.h
gunjjoshi Mar 3, 2024
5ac1730
Update lib/node_modules/@stdlib/math/base/special/ellipe/include/stdl…
gunjjoshi Mar 3, 2024
0ab415a
Update lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c
gunjjoshi Mar 3, 2024
470068b
Update lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c
gunjjoshi Mar 3, 2024
9c96407
Update lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c
gunjjoshi Mar 3, 2024
1ca5b7b
Update lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c
gunjjoshi Mar 3, 2024
ca64f5b
Update manifest.json
gunjjoshi Mar 3, 2024
2591e1e
Update lib/node_modules/@stdlib/math/base/special/ellipe/scripts/eval…
gunjjoshi Mar 4, 2024
fa86545
Update Makefile: added newline
gunjjoshi Mar 4, 2024
9929a53
Update benchmark.c: added newline
gunjjoshi Mar 4, 2024
6508483
Update binding.gyp: added newline
gunjjoshi Mar 4, 2024
ced872b
Update Makefile
gunjjoshi Mar 4, 2024
dcc1f13
Update example.c: added newline
gunjjoshi Mar 4, 2024
11dc760
Update large_negative.json: added newline
gunjjoshi Mar 4, 2024
c66d197
Update medium_negative.json: added newline
gunjjoshi Mar 4, 2024
c671987
Update lib/node_modules/@stdlib/math/base/special/ellipe/README.md
Pranavchiku Mar 4, 2024
2421ae5
Update lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c
gunjjoshi Mar 5, 2024
28049f2
Update test.native.js
gunjjoshi Mar 5, 2024
0a6ad6b
Update example.c: tab indentation.
gunjjoshi Mar 5, 2024
407bc90
Update main.c: tab indentation.
gunjjoshi Mar 5, 2024
6775e65
Update lib/node_modules/@stdlib/math/base/special/ellipe/examples/c/e…
gunjjoshi Mar 6, 2024
5d657df
Delete `lib/node_modules/@stdlib/math/base/special/ellipe/test/fixtur…
gunjjoshi Mar 6, 2024
002500f
Delete `lib/node_modules/@stdlib/math/base/special/ellipe/test/fixtur…
gunjjoshi Mar 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ellipe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,96 @@ for ( i = 0; i < 100; i++ ) {

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/math/base/special/ellipe.h"
```

#### stdlib_base_ellipe( m )

Computes the [complete elliptic integral of the second kind][elliptic-integral].

```c
double out = stdlib_base_ellipe( 0.5 );
// returns ~1.351

out = stdlib_base_ellipe( -1.0 );
// returns ~1.910
```

The function accepts the following arguments:

- **x**: `[in] double` input value.

```c
double stdlib_base_ellipe( const double m );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/math/base/special/ellipe.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
double m;
double v;
int i;

for ( i = 0; i < 100; i++ ) {
m = -1.0 + ( ( (double)rand() / (double)RAND_MAX ) * 2.0 );
v = stdlib_base_ellipe( m );
printf( "ellipe(%lf) = %lf\n", m, v );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

* * *

<section class="references">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var ellipe = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( ellipe instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = ellipe( randu() );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2024 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

# List of C targets:
c_targets := benchmark.out


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading
Loading