Skip to content

add C implementation to @stdlib/math/base/special/ldexp #652

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

Merged
merged 60 commits into from
Dec 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
cb334cc
Add c-api documentation in readme.md
Pranavchiku Dec 4, 2022
97ffe05
Add binding.gyp adn include.gypi
Pranavchiku Dec 4, 2022
64422ab
add ldexp.h
Pranavchiku Dec 4, 2022
8056d68
add main.c, addon.c, Makefile in src/
Pranavchiku Dec 4, 2022
bfaaa46
Add manifest.json
Pranavchiku Dec 4, 2022
27cc79e
fix indentation in manifest.json
Pranavchiku Dec 4, 2022
19ffc3a
add native.js
Pranavchiku Dec 4, 2022
40b741f
modifications in main.c
Pranavchiku Dec 4, 2022
5e10242
changes in main.c
Pranavchiku Dec 4, 2022
343c2c4
add missing semicolon
Pranavchiku Dec 4, 2022
cb38b3b
add example for c
Pranavchiku Dec 4, 2022
5c6dc93
sync examples of readme.md with example.c
Pranavchiku Dec 4, 2022
bae1fe2
add native benchmarks for c
Pranavchiku Dec 4, 2022
dd4f8b1
Update lib/node_modules/@stdlib/math/base/special/ldexp/README.md
Pranavchiku Dec 4, 2022
9a67427
Update lib/node_modules/@stdlib/math/base/special/ldexp/README.md
Pranavchiku Dec 4, 2022
032ae74
apply suggestion from code review
Pranavchiku Dec 4, 2022
234180c
Update lib/node_modules/@stdlib/math/base/special/ldexp/src/main.c
Pranavchiku Dec 4, 2022
2ab1544
Update lib/node_modules/@stdlib/math/base/special/ldexp/src/main.c
Pranavchiku Dec 4, 2022
f6b48fc
Apply suggestions from code review
kgryte Dec 5, 2022
15edd84
add benchmark.native.js
Pranavchiku Dec 5, 2022
b314a8c
fixes in main.c
Pranavchiku Dec 5, 2022
429f28c
add test.native.js
Pranavchiku Dec 5, 2022
d4e8f8e
Fix missing opts
kgryte Dec 5, 2022
21bb156
add stdlib constants in place of INFINITY
Pranavchiku Dec 5, 2022
0f71a7d
add ninf and pinf in dependencies
Pranavchiku Dec 5, 2022
3d053b1
Add linebreak
kgryte Dec 5, 2022
2a560b5
Order according to length
kgryte Dec 5, 2022
fc7f026
change numbers to stdlib constants
Pranavchiku Dec 5, 2022
c094df6
Add dependency in manifest.json
Pranavchiku Dec 5, 2022
b042af5
Apply suggestions from code review
kgryte Dec 6, 2022
019e332
Update description
kgryte Dec 6, 2022
20c94f1
Add c-api documentation in readme.md
Pranavchiku Dec 4, 2022
5c7764b
add binding.gyp
Pranavchiku Dec 4, 2022
71d52d7
add include.gypi
Pranavchiku Dec 4, 2022
473fa5b
add frexp.h
Pranavchiku Dec 4, 2022
ae37fe7
Add makefile and main.c
Pranavchiku Dec 4, 2022
d5304ff
Update lib/node_modules/@stdlib/math/base/special/frexp/README.md
Pranavchiku Dec 4, 2022
948afdb
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
ec6811b
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
bdbc63d
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
1ef3aee
Apply suggestion from code review
Pranavchiku Dec 4, 2022
9a4ab4d
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
68decf2
modifications in main.c
Pranavchiku Dec 4, 2022
e6686e6
Add addon.c
Pranavchiku Dec 4, 2022
82c4dc0
Remove get-high-word include
Pranavchiku Dec 4, 2022
637db52
add manifest.json
Pranavchiku Dec 4, 2022
de7d021
add native.js
Pranavchiku Dec 4, 2022
3338e2d
add example for c
Pranavchiku Dec 4, 2022
e3cfb65
add native benchmarks
Pranavchiku Dec 4, 2022
b29c82e
update package.json
Pranavchiku Dec 4, 2022
d95ec91
add benchmark for c
Pranavchiku Dec 4, 2022
751c9e4
modification in main.c
Pranavchiku Dec 4, 2022
9c02e65
Add missing colon
kgryte Dec 4, 2022
a9c63b8
Change type
kgryte Dec 4, 2022
47efddb
Fix invocation
kgryte Dec 4, 2022
d8d9c45
add native tests
Pranavchiku Dec 4, 2022
450839e
fix indentation in manifest.json
Pranavchiku Dec 5, 2022
2bdd5c5
Revert "Merge branch 'frexp2' into ldexp1"
Pranavchiku Dec 9, 2022
b03de25
Apply suggestions from code review
kgryte Dec 9, 2022
51e1f7a
Update example
kgryte Dec 9, 2022
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
94 changes: 93 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/ldexp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

@license Apache-2.0

Copyright (c) 2018 The Stdlib Authors.
Copyright (c) 2022 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.
Expand Down Expand Up @@ -118,6 +118,98 @@ 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/ldexp.h"
```

#### stdlib_base_ldexp( frac, exp )

Multiplies a [double-precision floating-point number][ieee754] by an integer power of two (i.e., `x = frac * 2^exp`).

```c
double x = stdlib_base_ldexp( 0.5, 3 ); // => 0.5 * 2^3 = 0.5 * 8
// returns 4.0
```

The function accepts the following arguments:

- **frac**: `[in] double` input value.
- **exp**: `[in] int32_t` integer power of two.

```c
double stdlib_base_ldexp( const double frac, const int32_t exp );
```

</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/ldexp.h"
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <inttypes.h>

int main() {
double frac;
int32_t exp;
double out;
int i;

for ( i = 0; i < 100; i++ ) {
frac = (double) rand() / (double) RAND_MAX;
exp = (int32_t) rand() - (int32_t) (RAND_MAX/2);
out = stdlib_base_ldexp( frac, exp );
printf( "frac: %lf, exp: %" PRId32 ", out: %lf\n", frac, exp, out );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2022 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 round = require( '@stdlib/math/base/special/round' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y = round( randu()*2040.0 ) - 1020.0;
z = ldexp( x, y );
if ( isnan( z ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( z ) ) {
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) 2022 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