diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/README.md b/lib/node_modules/@stdlib/number/float16/base/significand/README.md new file mode 100644 index 000000000000..864d983738b5 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/README.md @@ -0,0 +1,210 @@ + + +# significand + +> Return an integer corresponding to the significand of a [half-precision floating-point number][ieee754]. + +
+ +## Usage + +```javascript +var significand = require( '@stdlib/number/float16/base/significand' ); +``` + +#### significand( x ) + +Returns an integer corresponding to the significand of a [half-precision floating-point number][ieee754]. + +```javascript +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); + +var s = significand( toFloat16( 3.14 ) ); // => 1001001000 +// returns 584 + +s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101 +// returns 53 + +s = significand( toFloat16( -3.14 ) ); // => 1001001000 +// returns 584 + +s = significand( 0.0 ); // => 0000000000 +// returns 0 + +s = significand( NaN ); // => 1000000000 +// returns 512 +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var significand = require( '@stdlib/number/float16/base/significand' ); + +var frac; +var exp; +var x; +var s; +var i; + +// Generate random numbers and extract their significands... +for ( i = 0; i < 100; i++ ) { + frac = randu() * 10.0; + exp = round( randu()*13.0 ) - 7; + x = frac * pow( 10.0, exp ); + x = toFloat16( x ); + s = significand( x ); + console.log( 'x: %d. significand: %d.', x, s ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/number/float16/base/significand.h" +``` + +#### stdlib_base_float16_significand( x ) + +Returns an integer corresponding to the significand of a [half-precision floating-point number][ieee754]. + +```c +#include "stdlib/number/float16/ctor.h" +#include + +stdlib_float16_t x = stdlib_float16_from_bits( 51648 ); // => -11.5 +int16_t y = stdlib_base_float16_significand( x ); +``` + +The function accepts the following arguments: + +- **x**: `[in] stdlib_float16_t` input value. + +```c +int16_t stdlib_base_float16_significand( const stdlib_float16_t x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/number/float16/base/significand.h" +#include "stdlib/number/float16/ctor.h" +#include "stdlib/number/float32/base/to_float16.h" +#include +#include +#include + +int main( void ) { + const float x[] = { 4.0f, 0.0f, -0.0f, 1.0f, -1.0f, 3.14f, -3.14f, 1.0e38f, -1.0e38f, 1.0f/0.0f, -1.0f/0.0f, 0.0f/0.0f }; + + stdlib_float16_t v; + int16_t out; + int i; + for ( i = 0; i < 12; i++ ) { + v = stdlib_base_float32_to_float16( x[ i ] ); + out = stdlib_base_float16_significand( v ); + printf( "%f => %" PRId16 "\n", x[ i ], out ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.js b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.js new file mode 100644 index 000000000000..1c17bca2203e --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.js @@ -0,0 +1,55 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var map = require( '@stdlib/array/base/map' ); +var naryFunction = require( '@stdlib/utils/nary-function' ); +var pkg = require( './../package.json' ).name; +var significand = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = map( uniform( 100, -5.0e4, 5.0e4 ), naryFunction( toFloat16, 1 ) ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = significand( x[ i%x.length ] ); + 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(); +}); diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.native.js new file mode 100644 index 000000000000..0b824821c04f --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.native.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var map = require( '@stdlib/array/base/map' ); +var naryFunction = require( '@stdlib/utils/nary-function' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var significand = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( significand instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = map( uniform( 100, -5.0e4, 5.0e4 ), naryFunction( toFloat16, 1 ) ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = significand( x[ i%x.length ] ); + 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(); +}); diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/c/Makefile b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/float16/base/significand/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/c/benchmark.c new file mode 100644 index 000000000000..a7038b1c859e --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/benchmark/c/benchmark.c @@ -0,0 +1,139 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/float16/base/significand.h" +#include "stdlib/number/float64/base/to_float16.h" +#include "stdlib/number/float16/ctor.h" +#include +#include +#include +#include +#include +#include + +#define NAME "float16_significand" +#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 double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + stdlib_float16_t x[ 100 ]; + double elapsed; + int16_t out; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = stdlib_base_float64_to_float16( ( 1.0e7*rand_double() ) - 5.0e6 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + out = stdlib_base_float16_significand( x[ i%100 ] ); + if ( out < 0 ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( out < 0 ) { + 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 ); +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/binding.gyp b/lib/node_modules/@stdlib/number/float16/base/significand/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/docs/repl.txt b/lib/node_modules/@stdlib/number/float16/base/significand/docs/repl.txt new file mode 100644 index 000000000000..d4c69f6283f6 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/docs/repl.txt @@ -0,0 +1,31 @@ + +{{alias}}( x ) + Returns an integer corresponding to the significand of a half-precision + floating-point number. + + Parameters + ---------- + x: float + Half-precision floating-point number. + + Returns + ------- + out: integer + Significand. + + Examples + -------- + > var s = {{alias}}( {{alias:@stdlib/number/float64/base/to-float16}}( 3.14 ) ) + 584 + > s = {{alias}}( {{alias:@stdlib/number/float64/base/to-float16}}( 3.14e-6 ) ) + 53 + > s = {{alias}}( {{alias:@stdlib/number/float64/base/to-float16}}( -3.14 ) ) + 584 + > s = {{alias}}( 0.0 ) + 0 + > s = {{alias}}( NaN ) + 512 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/index.d.ts b/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/index.d.ts new file mode 100644 index 000000000000..6204a78bd600 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/index.d.ts @@ -0,0 +1,58 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns an integer corresponding to the significand of a half-precision floating-point number. +* +* @param x - half-precision floating-point number +* @returns significand +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( 3.14 ) ); // => 1001001000 +* // returns 584 +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101 +* // returns 53 +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( -3.14 ) ); // => 1001001000 +* // returns 584 +* +* @example +* var s = significand( 0.0 ); // => 0000000000 +* // returns 0 +* +* @example +* var s = significand( NaN ); // => 1000000000 +* // returns 512 +*/ +declare function significand( x: number ): number; + + +// EXPORTS // + +export = significand; diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/test.ts b/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/test.ts new file mode 100644 index 000000000000..1b68c90046fb --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/docs/types/test.ts @@ -0,0 +1,43 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +import significand = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + significand( 0.0 ); // $ExpectType number + significand( NaN ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + significand( true ); // $ExpectError + significand( false ); // $ExpectError + significand( 'abc' ); // $ExpectError + significand( [] ); // $ExpectError + significand( {} ); // $ExpectError + significand( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + significand(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/examples/c/Makefile b/lib/node_modules/@stdlib/number/float16/base/significand/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/float16/base/significand/examples/c/example.c b/lib/node_modules/@stdlib/number/float16/base/significand/examples/c/example.c new file mode 100644 index 000000000000..92711a23b6be --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/examples/c/example.c @@ -0,0 +1,37 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/float16/base/significand.h" +#include "stdlib/number/float16/ctor.h" +#include "stdlib/number/float32/base/to_float16.h" +#include +#include +#include + +int main( void ) { + const float x[] = { 4.0f, 0.0f, -0.0f, 1.0f, -1.0f, 3.14f, -3.14f, 1.0e38f, -1.0e38f, 1.0f/0.0f, -1.0f/0.0f, 0.0f/0.0f }; + + stdlib_float16_t v; + int16_t out; + int i; + for ( i = 0; i < 12; i++ ) { + v = stdlib_base_float32_to_float16( x[ i ] ); + out = stdlib_base_float16_significand( v ); + printf( "%f => %" PRId16 "\n", x[ i ], out ); + } +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/examples/index.js b/lib/node_modules/@stdlib/number/float16/base/significand/examples/index.js new file mode 100644 index 000000000000..7134fdf8fb89 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/examples/index.js @@ -0,0 +1,41 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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'; + +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var significand = require( './../lib' ); + +var frac; +var exp; +var x; +var s; +var i; + +// Generate random numbers and extract their significands... +for ( i = 0; i < 100; i++ ) { + frac = randu() * 10.0; + exp = round( randu()*13.0 ) - 7; + x = frac * pow( 10.0, exp ); + x = toFloat16( x ); + s = significand( x ); + console.log( 'x: %d. significand: %d.', x, s ); +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/include.gypi b/lib/node_modules/@stdlib/number/float16/base/significand/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Returns an integer corresponding to the significand of a half-precision floating-point number. +*/ +int16_t stdlib_base_float16_significand( const stdlib_float16_t x ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_NUMBER_FLOAT16_BASE_SIGNIFICAND_H diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/lib/index.js b/lib/node_modules/@stdlib/number/float16/base/significand/lib/index.js new file mode 100644 index 000000000000..a4d7c748d3d5 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/lib/index.js @@ -0,0 +1,53 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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'; + +/** +* Return an integer corresponding to the significand of a half-precision floating-point number. +* +* @module @stdlib/number/float16/base/significand +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* var significand = require( '@stdlib/number/float16/base/significand' ); +* +* var s = significand( toFloat16( 3.14 ) ); // => 1001001000 +* // returns 584 +* +* s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101 +* // returns 53 +* +* s = significand( toFloat16( -3.14 ) ); // => 1001001000 +* // returns 584 +* +* s = significand( 0.0 ); // => 0000000000 +* // returns 0 +* +* s = significand( NaN ); // => 1000000000 +* // returns 512 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/lib/main.js b/lib/node_modules/@stdlib/number/float16/base/significand/lib/main.js new file mode 100644 index 000000000000..148a9a8539c3 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/lib/main.js @@ -0,0 +1,72 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 FLOAT16_SIGNIFICAND_MASK = require( '@stdlib/constants/float16/significand-mask' ); +var getWord = require( '@stdlib/number/float16/base/to-word' ); + + +// MAIN // + +/** +* Returns an integer corresponding to the significand of a half-precision floating-point number. +* +* @param {number} x - half-precision floating-point number +* @returns {uinteger16} significand +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( 3.14 ) ); // => 1001001000 +* // returns 584 +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101 +* // returns 53 +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( -3.14 ) ); // => 1001001000 +* // returns 584 +* +* @example +* var s = significand( 0.0 ); // => 0000000000 +* // returns 0 +* +* @example +* var s = significand( NaN ); // => 1000000000 +* // returns 512 +*/ +function significand( x ) { + // Convert `x` to an unsigned 16-bit integer corresponding to the IEEE 754 binary representation: + var w = getWord( x ); + + // Apply a mask to isolate only the significand bits: + return w & FLOAT16_SIGNIFICAND_MASK; +} + + +// EXPORTS // + +module.exports = significand; diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/lib/native.js b/lib/node_modules/@stdlib/number/float16/base/significand/lib/native.js new file mode 100644 index 000000000000..359b591c89a0 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/lib/native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Returns an integer corresponding to the significand of a half-precision floating-point number. +* +* @private +* @param {number} x - half-precision floating-point number +* @returns {integer16} significand +* +* @example +* var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +* +* var s = significand( toFloat16( 3.14 ) ); // => 1001001000 +* // returns 584 +* +* var s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101 +* // returns 53 +* +* var s = significand( toFloat16( -3.14 ) ); // => 1001001000 +* // returns 584 +* +* var s = significand( 0.0 ); // => 0000000000 +* // returns 0 +* +* var s = significand( NaN ); // => 1000000000 +* // returns 512 +*/ +function significand( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = significand; diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/manifest.json b/lib/node_modules/@stdlib/number/float16/base/significand/manifest.json new file mode 100644 index 000000000000..0018965ee248 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/manifest.json @@ -0,0 +1,81 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/number/float64/base/to-float16", + "@stdlib/number/float16/base/to-word", + "@stdlib/constants/float16/significand-mask", + "@stdlib/number/float16/ctor" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/number/float64/base/to-float16", + "@stdlib/number/float16/base/to-word", + "@stdlib/constants/float16/significand-mask", + "@stdlib/number/float16/ctor" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/number/float32/base/to-float16", + "@stdlib/number/float16/base/to-word", + "@stdlib/constants/float16/significand-mask", + "@stdlib/number/float16/ctor" + ] + } + ] +} + diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/package.json b/lib/node_modules/@stdlib/number/float16/base/significand/package.json new file mode 100644 index 000000000000..6956b112c0a0 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/package.json @@ -0,0 +1,79 @@ +{ + "name": "@stdlib/number/float16/base/significand", + "version": "0.0.0", + "description": "Return an integer corresponding to the significand of a half-precision floating-point number.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdtypes", + "base", + "utilities", + "utility", + "utils", + "util", + "types", + "type", + "significand", + "mantissa", + "fraction", + "frac", + "coefficient", + "bits", + "floating-point", + "float16", + "float", + "half", + "16-bit", + "ieee754", + "number", + "word" + ] +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/src/Makefile b/lib/node_modules/@stdlib/number/float16/base/significand/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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 + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/src/addon.c b/lib/node_modules/@stdlib/number/float16/base/significand/src/addon.c new file mode 100644 index 000000000000..9602f963925d --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/src/addon.c @@ -0,0 +1,90 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/float16/base/significand.h" +#include "stdlib/number/float64/base/to_float16.h" +#include +#include +#include +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + napi_status status; + + // Get callback arguments: + size_t argc = 1; + napi_value argv[ 1 ]; + status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL ); + assert( status == napi_ok ); + + // Check whether we were provided the correct number of arguments: + if ( argc < 1 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." ); + assert( status == napi_ok ); + return NULL; + } + if ( argc > 1 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." ); + assert( status == napi_ok ); + return NULL; + } + + napi_valuetype vtype0; + status = napi_typeof( env, argv[ 0 ], &vtype0 ); + assert( status == napi_ok ); + if ( vtype0 != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a number." ); + assert( status == napi_ok ); + return NULL; + } + + double value; + status = napi_get_value_double( env, argv[ 0 ], &value ); + assert( status == napi_ok ); + + int16_t out = stdlib_base_float16_significand( stdlib_base_float64_to_float16( value ) ); + + napi_value v; + status = napi_create_int32( env, out, &v ); + assert( status == napi_ok ); + + return v; +} + +/** +* Initializes a Node-API module. +* +* @param env environment under which the function is invoked +* @param exports exports object +* @return main export +*/ +static napi_value init( napi_env env, napi_value exports ) { + napi_value fcn; + napi_status status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, addon, NULL, &fcn ); + assert( status == napi_ok ); + return fcn; +} + +NAPI_MODULE( NODE_GYP_MODULE_NAME, init ) diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/src/main.c b/lib/node_modules/@stdlib/number/float16/base/significand/src/main.c new file mode 100644 index 000000000000..7bd5f1d1f652 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/src/main.c @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/float16/base/significand.h" +#include "stdlib/number/float16/base/to_word.h" +#include "stdlib/constants/float16/significand_mask.h" +#include "stdlib/number/float16/ctor.h" +#include + +/** +* Returns the integer corresponding to the significand of a half-precision floating-point number. +* +* @param x input value +* @return integer corresponding to the significand +* +* @example +* #include "stdlib/number/float16/ctor.h" +* #include +* +* stdlib_float16_t x = stdlib_float16_from_bits( 51648 ); // => -11.5 +* int16_t y = stdlib_base_float16_significand( x ); +*/ +int16_t stdlib_base_float16_significand( const stdlib_float16_t x ) { + // Convert `x` to an unsigned 16-bit integer corresponding to the IEEE 754 binary representation: + uint16_t word; + stdlib_base_float16_to_word( x, &word ); + + // Apply a mask to isolate only the significand bits: + word &= STDLIB_CONSTANT_FLOAT16_SIGNIFICAND_MASK; + + // Convert the significand bits to an integer: + return (int16_t)word; +} diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/test/test.js b/lib/node_modules/@stdlib/number/float16/base/significand/test/test.js new file mode 100644 index 000000000000..402c9f9512a8 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/test/test.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tape = require( 'tape' ); +var PINF = require( '@stdlib/constants/float16/pinf' ); +var NINF = require( '@stdlib/constants/float16/ninf' ); +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var bits = require( '@stdlib/number/float16/base/to-binary-string' ); +var significand = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof significand, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns a number', function test( t ) { + t.strictEqual( typeof significand( toFloat16( 3.14e3 ) ), 'number', 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns an integer corresponding to the significand of a half-precision floating-point number', function test( t ) { + var expected; + var actual; + var sign; + var frac; + var exp; + var x; + var b; + var i; + + for ( i = 0; i < 5000; i++ ) { + if ( randu() < 0.5 ) { + sign = -1.0; + } else { + sign = 1.0; + } + frac = randu() * 10.0; + exp = round( randu()*13.0 ) - 7; + x = sign * frac * pow( 10.0, exp ); + x = toFloat16( x ); + + b = bits( x ); + expected = parseInt( b.substring( 6 ), 2 ); + + actual = significand( x ); + t.strictEqual( actual, expected, 'returns the significand for ' + x ); + } + t.end(); +}); + +tape( 'the function returns the significand for `+-0`', function test( t ) { + t.strictEqual( significand( 0.0 ), 0, 'returns expected value' ); + t.strictEqual( significand( -0.0 ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `+infinity`', function test( t ) { + t.strictEqual( significand( PINF ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `-infinity`', function test( t ) { + t.strictEqual( significand( NINF ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `NaN`', function test( t ) { + t.strictEqual( significand( NaN ), 512, 'returns expected value' ); // bit sequence: 1000000000 + t.end(); +}); + +tape( 'the function returns the significand for subnormals', function test( t ) { + var x = toFloat16( 3.14e-8 ); + var s = parseInt( bits( x ).substring( 6 ), 2 ); + t.strictEqual( significand( x ), s, 'returns the significand for ' + x ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/number/float16/base/significand/test/test.native.js b/lib/node_modules/@stdlib/number/float16/base/significand/test/test.native.js new file mode 100644 index 000000000000..70f3d0ad9962 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float16/base/significand/test/test.native.js @@ -0,0 +1,112 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tape = require( 'tape' ); +var PINF = require( '@stdlib/constants/float16/pinf' ); +var NINF = require( '@stdlib/constants/float16/ninf' ); +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var toFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var bits = require( '@stdlib/number/float16/base/to-binary-string' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var significand = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( significand instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof significand, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns a number', opts, function test( t ) { + t.strictEqual( typeof significand( toFloat16( 3.14e3 ) ), 'number', 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns an integer corresponding to the significand of a half-precision floating-point number', opts, function test( t ) { + var expected; + var actual; + var sign; + var frac; + var exp; + var x; + var b; + var i; + + for ( i = 0; i < 5000; i++ ) { + if ( randu() < 0.5 ) { + sign = -1.0; + } else { + sign = 1.0; + } + frac = randu() * 10.0; + exp = round( randu()*13.0 ) - 7; + x = sign * frac * pow( 10.0, exp ); + x = toFloat16( x ); + + b = bits( x ); + expected = parseInt( b.substring( 6 ), 2 ); + + actual = significand( x ); + t.strictEqual( actual, expected, 'returns the significand for ' + x ); + } + t.end(); +}); + +tape( 'the function returns the significand for `+-0`', opts, function test( t ) { + t.strictEqual( significand( 0.0 ), 0, 'returns expected value' ); + t.strictEqual( significand( -0.0 ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `+infinity`', opts, function test( t ) { + t.strictEqual( significand( PINF ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `-infinity`', opts, function test( t ) { + t.strictEqual( significand( NINF ), 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the significand for `NaN`', opts, function test( t ) { + t.strictEqual( significand( NaN ), 512, 'returns expected value' ); // bit sequence: 1000000000 + t.end(); +}); + +tape( 'the function returns the significand for subnormals', opts, function test( t ) { + var x = toFloat16( 3.14e-8 ); + var s = parseInt( bits( x ).substring( 6 ), 2 ); + t.strictEqual( significand( x ), s, 'returns the significand for ' + x ); + t.end(); +});