From 6c12866cbd33a05e0407500d58af37ef6da72217 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Tue, 10 Dec 2024 23:25:07 +0530 Subject: [PATCH 01/20] feat: add benchmarks --- .../signbit/benchmark/benchmark.native.js | 61 ++++++++ .../float32/base/signbit/benchmark/c/Makefile | 146 ++++++++++++++++++ .../base/signbit/benchmark/c/benchmark.c | 134 ++++++++++++++++ 3 files changed, 341 insertions(+) create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/benchmark.c diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/benchmark.native.js new file mode 100644 index 000000000000..ee48f0af39e4 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/benchmark.native.js @@ -0,0 +1,61 @@ +/** +* @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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var toFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var signbitf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( signbitf 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 = signbitf( toFloat32( x ) ); + if ( typeof y !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( y ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/Makefile b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/Makefile new file mode 100644 index 000000000000..d6b58c7f5d3e --- /dev/null +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/Makefile @@ -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 diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/benchmark.c new file mode 100644 index 000000000000..a2ff7bf8150b --- /dev/null +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/benchmark/c/benchmark.c @@ -0,0 +1,134 @@ +float/** +* @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. +*/ + +#include "stdlib/number/float32/base/signbit.h" +#include +#include +#include +#include +#include +#include + +#define NAME "float32_signbit" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + int8_t out; + float x; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( rand_float()*200.0f ) - 100.0f; + out = stdlib_base_float32_signbit( x ); + if ( out != 0 && out != 1 ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( out != 0 && out != 1 ) { + printf( "unexpected result\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main ( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} From c30b8fa0c86a3e7933a8b906cd35035beb49705d Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Tue, 10 Dec 2024 23:31:09 +0530 Subject: [PATCH 02/20] feat: add examples --- .../float32/base/signbit/examples/c/Makefile | 146 ++++++++++++++++++ .../float32/base/signbit/examples/c/example.c | 34 ++++ 2 files changed, 180 insertions(+) create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/example.c diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/Makefile b/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/Makefile new file mode 100644 index 000000000000..91d364d19fc3 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/Makefile @@ -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 := example.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 examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/example.c b/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/example.c new file mode 100644 index 000000000000..3295ff977bb9 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @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. +*/ + +#include "stdlib/number/float32/base/signbit.h" +#include +#include +#include + +int main( void ) { + float x[] = { 3.14f, -3.14f, 0.0f, -0.0f, 4.0f, 1.0f, -1.0f, 1.0e308f, -1.0e308f }; + + int8_t out; + int i; + for ( i = 0; i < 9; i++ ) { + out = stdlib_base_float32_signbit( x[ i ] ); + printf( "%f => signbit: %" PRId8 "\n", x[ i ], out ); + } +} + From 9361a1a84115bbc66af96f15898d68ea6287149e Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Wed, 11 Dec 2024 00:21:32 +0530 Subject: [PATCH 03/20] feat: add essential files --- .../number/float32/base/signbit/README.md | 84 ++++++++- .../number/float32/base/signbit/binding.gyp | 170 ++++++++++++++++++ .../number/float32/base/signbit/include.gypi | 53 ++++++ .../float32/base/signbit/include/signbit.h | 40 +++++ .../number/float32/base/signbit/lib/native.js | 59 ++++++ .../number/float32/base/signbit/manifest.json | 40 +++++ .../number/float32/base/signbit/src/Makefile | 70 ++++++++ .../number/float32/base/signbit/src/addon.c | 89 +++++++++ .../number/float32/base/signbit/src/main.c | 42 +++++ 9 files changed, 646 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/binding.gyp create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/include.gypi create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/include/signbit.h create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/lib/native.js create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/manifest.json create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/src/Makefile create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/src/addon.c create mode 100644 lib/node_modules/@stdlib/number/float32/base/signbit/src/main.c diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/README.md b/lib/node_modules/@stdlib/number/float32/base/signbit/README.md index 0f70925481c0..4457c2ae9c7a 100644 --- a/lib/node_modules/@stdlib/number/float32/base/signbit/README.md +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/README.md @@ -18,7 +18,7 @@ limitations under the License. --> -# signbit +# signbitf > Return a boolean indicating if the sign bit for a [single-precision floating-point number][ieee754] is on (true) or off (false). @@ -82,6 +82,88 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/number/float32/base/signbit.h" +``` + +#### stdlib_base_float32_signbit( x ) + +Returns an integer indicating whether the sign bit for a float-precision floating-point number is on (`1`) or off (`0`). + +```c +#include + +int8_t out = stdlib_base_float32_signbit( 3.14f ); +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. + +```c +int8_t stdlib_base_float32_signbit( const float x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/number/float32/base/signbit.h" +#include +#include +#include + +int main( void ) { + float x[] = { 3.14f, -3.14f, 0.0f, -0.0f, 4.0f, 1.0f, -1.0f, 1.0e308f, -1.0e308f }; + + int8_t out; + int i; + for ( i = 0; i < 9; i++ ) { + stdlib_base_float32_signbit( x[ i ], &out ); + printf( "%f => signbit: %" PRId8 "\n", x[ i ], out ); + } +} +``` + +
+