Skip to content

add C implementation for @stdlib/math/base/special/frexp #651

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 29 commits into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c349ba2
Add c-api documentation in readme.md
Pranavchiku Dec 4, 2022
d22a3c7
add binding.gyp
Pranavchiku Dec 4, 2022
e73e43f
add include.gypi
Pranavchiku Dec 4, 2022
cbbf989
add frexp.h
Pranavchiku Dec 4, 2022
3b3e7c5
Add makefile and main.c
Pranavchiku Dec 4, 2022
ba71b80
Update lib/node_modules/@stdlib/math/base/special/frexp/README.md
Pranavchiku Dec 4, 2022
e163886
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
752e620
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
b85998b
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
6a72f4d
Apply suggestion from code review
Pranavchiku Dec 4, 2022
516afb2
Update lib/node_modules/@stdlib/math/base/special/frexp/src/main.c
Pranavchiku Dec 4, 2022
b86af00
modifications in main.c
Pranavchiku Dec 4, 2022
1edbb58
Add addon.c
Pranavchiku Dec 4, 2022
c8feb2d
Remove get-high-word include
Pranavchiku Dec 4, 2022
077da4a
add manifest.json
Pranavchiku Dec 4, 2022
69a1f4f
add native.js
Pranavchiku Dec 4, 2022
cd98d1a
add example for c
Pranavchiku Dec 4, 2022
8b6b8f8
add native benchmarks
Pranavchiku Dec 4, 2022
a1ee06f
update package.json
Pranavchiku Dec 4, 2022
52cc3e5
add benchmark for c
Pranavchiku Dec 4, 2022
5f3d3ef
modification in main.c
Pranavchiku Dec 4, 2022
b839728
Add missing colon
kgryte Dec 4, 2022
b1ecef6
Change type
kgryte Dec 4, 2022
d5c64d4
Fix invocation
kgryte Dec 4, 2022
cd3f3eb
add native tests
Pranavchiku Dec 4, 2022
80ae626
fix indentation in manifest.json
Pranavchiku Dec 5, 2022
d357763
Apply suggestions from code review
kgryte Dec 6, 2022
6ef09bd
Fix example
kgryte Dec 6, 2022
4a04a42
Fix assertions
kgryte Dec 6, 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: 94 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/frexp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,100 @@ 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/frexp.h"
```

#### stdlib_base_frexp( x, frac, exp )

Splits a [double-precision floating-point number][ieee754] into a normalized fraction and an integer power of two.

```c
#include <stdint.h>

double frac;
int32_t exp;
stdlib_base_frexp( 4.0, &frac, &exp );
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **frac**: `[out] double*` destination for the normalized fraction.
- **exp**: `[out] int32_t*` destination for the integer power of two.


```c
void stdlib_base_frexp( const double x, double *frac, 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/frexp.h"
#include <stdint.h>
#include <stdio.h>
#include <inttypes.h>

int main() {
double x[] = { 4.0, 0.0, -0.0, 1.0, -1.0, 3.14, -3.14, 1.0e308, -1.0e308, 1.0/0.0, -1.0/0.0, 0.0/0.0 };

double frac;
int32_t exp;
int i;
for ( i = 0; i < 12; i++ ) {
stdlib_base_frexp( x[i], &frac, &exp );
printf( "x: %f => frac: %f, exp: %" PRId32 "\n", x[i], frac, exp );
}
}
```

</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,60 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 isArray = require( '@stdlib/assert/is-array' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*1.0e7 ) - 5.0e6;
y = frexp( x );
if ( typeof y !== 'object' ) {
b.fail( 'should return an array' );
}
}
b.toc();
if ( !isArray( y ) ) {
b.fail( 'should return an array' );
}
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