diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/README.md b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/README.md index f8cc6d2cd027..c8d3bca21063 100644 --- a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/README.md +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/README.md @@ -121,6 +121,109 @@ console.log( d ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/number/float64/base/ulp_difference.h" +``` + +#### stdlib_base_float64_ulp_difference( x, y ) + +Computes the number of representable [double-precision][double-precision] floating-point values that separate two [double-precision][double-precision] floating-point numbers along the real number line. + +```c +#include "stdlib/constants/float64/eps.h" + +double d = stdlib_base_float64_ulp_difference( 1.0, 1.0 + STDLIB_CONSTANT_FLOAT64_EPS ); +// returns 1.0 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` first input value. +- **y**: `[in] double` second input value. + +```c +double stdlib_base_float64_ulp_difference( const double x, const double y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/number/float64/base/ulp_difference.h" +#include "stdlib/constants/float64/eps.h" +#include "stdlib/constants/float64/smallest_subnormal.h" +#include + +int main( void ) { + const double x[] = { + 1.0, + 5.8364e-319, + 0.0, + 0.0, + STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL + }; + const double y[] = { + 1.0 + STDLIB_CONSTANT_FLOAT64_EPS, + 5.8367e-319, + STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL, + -0.0, + -STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL + }; + + double d; + int i; + for ( i = 0; i < 5; i++ ) { + d = stdlib_base_float64_ulp_difference( x[ i ], y[ i ] ); + printf( "ulpdiff(%lf, %lf) = %lf\n", x[ i ], y[ i ], d ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/benchmark.native.js new file mode 100644 index 000000000000..0bb68e8c44ce --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/benchmark.native.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 tryRequire = require( '@stdlib/utils/try-require' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var ulpdiff = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ulpdiff instanceof Error ) +}; + + +// MAIN // + +bench( format( '%s::native', pkg ), opts, function benchmark( b ) { + var x; + var y; + var d; + var i; + + x = uniform( 100, -500.0, 500.0 ); + y = uniform( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = ulpdiff( x[ i%x.length ], y[ i%y.length ] ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/c/Makefile b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/c/Makefile new file mode 100644 index 000000000000..979768abbcec --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/float64/base/ulp-difference/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/c/benchmark.c new file mode 100644 index 000000000000..7e6ccce0f94c --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/benchmark/c/benchmark.c @@ -0,0 +1,144 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/float64/base/ulp_difference.h" +#include +#include +#include +#include +#include + +#define NAME "float64_ulp_difference" +#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 [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*( max-min ) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double out; + double t; + double *x; + double *y; + int i; + + x = (double *)malloc( 100 * sizeof( double ) ); + y = (double *)malloc( 100 * sizeof( double ) ); + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( -500.0, 500.0 ); + y[ i ] = random_uniform( -500.0, 500.0 ); + } + out = 0.0; // cppcheck-suppress uninitvar + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + out = stdlib_base_float64_ulp_difference( x[ i%100 ], y[ i%100 ] ); + if ( out != out ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( out != out ) { + printf( "unexpected result\n" ); + } + free( x ); + free( y ); + 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::%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/float64/base/ulp-difference/binding.gyp b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/float64/base/ulp-difference/examples/c/Makefile b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/float64/base/ulp-difference/examples/c/example.c b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/examples/c/example.c new file mode 100644 index 000000000000..cd27bd7beeef --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/examples/c/example.c @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/float64/base/ulp_difference.h" +#include "stdlib/constants/float64/eps.h" +#include "stdlib/constants/float64/smallest_subnormal.h" +#include + +int main( void ) { + const double x[] = { + 1.0, + 5.8364e-319, + 0.0, + 0.0, + STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL + }; + const double y[] = { + 1.0 + STDLIB_CONSTANT_FLOAT64_EPS, + 5.8367e-319, + STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL, + -0.0, + -STDLIB_CONSTANT_FLOAT64_SMALLEST_SUBNORMAL + }; + + double d; + int i; + for ( i = 0; i < 5; i++ ) { + d = stdlib_base_float64_ulp_difference( x[ i ], y[ i ] ); + printf( "ulpdiff(%lf, %lf) = %lf\n", x[ i ], y[ i ], d ); + } +} diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/include.gypi b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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 + +/** +* An opaque type definition for a union for converting between a double-precision floating-point number and an unsigned 64-bit integer. +* +* @example +* #include +* +* stdlib_base_float64_ulp_difference_word_t w; +* +* // Assign a double-precision floating-point number: +* w.value = 3.14; +* +* // Extract the unsigned 64-bit integer: +* uint64_t word = w.word; +*/ +typedef union { + double value; + uint64_t word; +} stdlib_base_float64_ulp_difference_word_t; + +/** +* Computes the number of representable double-precision floating-point values that separate two double-precision floating-point numbers along the real number line. +*/ +double stdlib_base_float64_ulp_difference( const double x, const double y ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_NUMBER_FLOAT64_BASE_ULP_DIFFERENCE_H diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/lib/native.js b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/lib/native.js new file mode 100644 index 000000000000..f00f28754070 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/lib/native.js @@ -0,0 +1,53 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 // + +/** +* Computes the number of representable double-precision floating-point values that separate two double-precision floating-point numbers along the real number line. +* +* @private +* @param {number} x - first value +* @param {number} y - second value +* @returns {number} result +* +* @example +* var EPS = require( '@stdlib/constants/float64/eps' ); +* +* var d = ulpdiff( 1.0, 1.0+EPS ); +* // returns 1.0 +* +* @example +* var d = ulpdiff( 1.0, NaN ); +* // returns NaN +*/ +function ulpdiff( x, y ) { + return addon( x, y ); +} + + +// EXPORTS // + +module.exports = ulpdiff; diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/manifest.json b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/manifest.json new file mode 100644 index 000000000000..19dcb117a7f5 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/manifest.json @@ -0,0 +1,80 @@ +{ + "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/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-double", + "@stdlib/napi/create-double", + "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/high-word-sign-mask" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/high-word-sign-mask" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/high-word-sign-mask", + "@stdlib/constants/float64/eps", + "@stdlib/constants/float64/smallest-subnormal" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/package.json b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/package.json index c09b26eac2e5..fe51a6ee155f 100644 --- a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/package.json +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/package.json @@ -14,11 +14,14 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", "example": "./examples", + "include": "./include", "lib": "./lib", + "src": "./src", "test": "./test" }, "types": "./docs/types", diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/Makefile b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/float64/base/ulp-difference/src/addon.c b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/addon.c new file mode 100644 index 000000000000..dc9c9dfa5cda --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/addon.c @@ -0,0 +1,41 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/float64/base/ulp_difference.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_double.h" +#include "stdlib/napi/create_double.h" +#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 ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 2 ); + STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 ); + STDLIB_NAPI_ARGV_DOUBLE( env, y, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_base_float64_ulp_difference( x, y ), out ); + return out; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/main.c b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/main.c new file mode 100644 index 000000000000..6309465c3821 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/src/main.c @@ -0,0 +1,75 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/float64/base/ulp_difference.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/constants/float64/high_word_sign_mask.h" +#include + +static const uint64_t SIGN_MASK = (uint64_t)STDLIB_CONSTANT_FLOAT64_HIGH_WORD_SIGN_MASK << 32; + +/** +* Converts a 64-bit unsigned integer corresponding to the IEEE 754 binary representation of a double-precision floating-point number to a lexicographically ordered integer. +* +* @param word unsigned 64-bit integer +* @return lexicographically ordered integer +*/ +static uint64_t monotone_key( const uint64_t word ) { + if ( word & SIGN_MASK ) { + return ~word + 1; + } + return word | SIGN_MASK; +} + +/** +* Computes the number of representable double-precision floating-point values that separate two double-precision floating-point numbers along the real number line. +* +* @param x first double-precision floating-point number +* @param y second double-precision floating-point number +* @return result +* +* @example +* #include "stdlib/constants/float64/eps.h" +* +* double d = stdlib_base_float64_ulp_difference( 1.0, 1.0 + STDLIB_CONSTANT_FLOAT64_EPS ); +* // returns 1.0 +* +* @example +* double d = stdlib_base_float64_ulp_difference( 0.0 / 0.0, 1.0 ); +* // returns 0.0/0.0 +*/ +double stdlib_base_float64_ulp_difference( const double x, const double y ) { + stdlib_base_float64_ulp_difference_word_t ux; + stdlib_base_float64_ulp_difference_word_t uy; + uint64_t wx; + uint64_t wy; + + if ( stdlib_base_is_nan( x ) || stdlib_base_is_nan( y ) ) { + return 0.0 / 0.0; + } + ux.value = x; + uy.value = y; + + wx = monotone_key( ux.word ); + wy = monotone_key( uy.word ); + + if ( wx >= wy ) { + return (double)( wx - wy ); + } + return (double)( wy - wx ); +} diff --git a/lib/node_modules/@stdlib/number/float64/base/ulp-difference/test/test.native.js b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/test/test.native.js new file mode 100644 index 000000000000..b915897b4931 --- /dev/null +++ b/lib/node_modules/@stdlib/number/float64/base/ulp-difference/test/test.native.js @@ -0,0 +1,125 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveFinite = require( '@stdlib/assert/is-positive-finite' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var SMALLEST_SUBNORMAL = require( '@stdlib/constants/float64/smallest-subnormal' ); +var MAX_VALUE = require( '@stdlib/constants/float64/max' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var ulpdiff = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ulpdiff instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ulpdiff, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the ULP difference between two double-precision floating-point numbers', opts, function test( t ) { + t.strictEqual( ulpdiff( 1.0, 1.0+EPS ), 1.0, 'returns expected value' ); + t.strictEqual( ulpdiff( 1.0+EPS, 1.0 ), 1.0, 'returns expected value' ); + + t.strictEqual( ulpdiff( 1.0, 1.0+( EPS*2.0 ) ), 2.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -1.0, -1.0+EPS ), 2.0, 'returns expected value' ); + + t.strictEqual( ulpdiff( -1.0, -1.0-( EPS*2.0 ) ), 2.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -1.0, -1.0+( EPS*2.0 ) ), 4.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function handles signed zeros', opts, function test( t ) { + t.strictEqual( ulpdiff( 0.0, -0.0 ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -0.0, 0.0 ), 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `0` for identical values', opts, function test( t ) { + t.strictEqual( ulpdiff( 5.0, 5.0 ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -5.0, -5.0 ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( 0.0, 0.0 ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -0.0, -0.0 ), 0.0, 'returns expected value' ); + + t.strictEqual( ulpdiff( SMALLEST_SUBNORMAL, SMALLEST_SUBNORMAL ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -SMALLEST_SUBNORMAL, -SMALLEST_SUBNORMAL ), 0.0, 'returns expected value' ); + + t.strictEqual( ulpdiff( PINF, PINF ), 0.0, 'returns expected value' ); + t.strictEqual( ulpdiff( NINF, NINF ), 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function handles infinities', opts, function test( t ) { + t.strictEqual( isPositiveFinite( ulpdiff( 5.0, PINF ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveFinite( ulpdiff( PINF, 5.0 ) ), true, 'returns expected value' ); + + t.strictEqual( isPositiveFinite( ulpdiff( 5.0, NINF ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveFinite( ulpdiff( NINF, 5.0 ) ), true, 'returns expected value' ); + + t.strictEqual( isPositiveFinite( ulpdiff( PINF, NINF ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveFinite( ulpdiff( NINF, PINF ) ), true, 'returns expected value' ); + + t.strictEqual( ulpdiff( MAX_VALUE, PINF ), 1.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -MAX_VALUE, NINF ), 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function handles subnormal numbers', opts, function test( t ) { + t.strictEqual( ulpdiff( SMALLEST_SUBNORMAL, 0.0 ), 1.0, 'returns expected value' ); + t.strictEqual( ulpdiff( 0.0, SMALLEST_SUBNORMAL ), 1.0, 'returns expected value' ); + + t.strictEqual( ulpdiff( SMALLEST_SUBNORMAL, -SMALLEST_SUBNORMAL ), 2.0, 'returns expected value' ); + t.strictEqual( ulpdiff( -SMALLEST_SUBNORMAL, SMALLEST_SUBNORMAL ), 2.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `NaN`, the function returns `NaN`', opts, function test( t ) { + t.strictEqual( isnan( ulpdiff( NaN, 5.0 ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( NaN, PINF ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( NaN, NINF ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( NaN, SMALLEST_SUBNORMAL ) ), true, 'returns expected value' ); + + t.strictEqual( isnan( ulpdiff( 5.0, NaN ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( PINF, NaN ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( NINF, NaN ) ), true, 'returns expected value' ); + t.strictEqual( isnan( ulpdiff( SMALLEST_SUBNORMAL, NaN ) ), true, 'returns expected value' ); + + t.strictEqual( isnan( ulpdiff( NaN, NaN ) ), true, 'returns expected value' ); + + t.end(); +});