diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/README.md b/lib/node_modules/@stdlib/math/base/special/roundsd/README.md index 67b162fdb58a..18ddc4413447 100644 --- a/lib/node_modules/@stdlib/math/base/special/roundsd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/README.md @@ -85,36 +85,106 @@ logEachMap( 'x: %0.4f. y: %d. Rounded: %0.4f.', x, 5, roundsd ); - - -
+ * * * -## See Also +
+ +## C APIs -- [`@stdlib/math/base/special/ceilsd`][@stdlib/math/base/special/ceilsd]: round a numeric value to the nearest number toward positive infinity with N significant figures. -- [`@stdlib/math/base/special/floorsd`][@stdlib/math/base/special/floorsd]: round a numeric value to the nearest number toward negative infinity with N significant figures. -- [`@stdlib/math/base/special/round`][@stdlib/math/base/special/round]: round a numeric value to the nearest integer. -- [`@stdlib/math/base/special/truncsd`][@stdlib/math/base/special/truncsd]: round a numeric value to the nearest number toward zero with N significant figures. + + +
- + - + -
+
- +### Usage + +```c +#include "stdlib/math/base/special/roundsd.h" +``` + +#### stdlib_base_roundsd( x, n, b ) + +Rounds a `numeric` value to the nearest `number` with `n` significant figures. + +```c +double v = stdlib_base_roundsd( 3.141592653589793, 3, 10 ); +// returns 3.14 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **n**: `[in] int32_t` number of significant figures. +- **b**: `[in] int32_t` base. + +```c +double stdlib_base_roundsd( const double x, const int32_t n, const int32_t b ); +``` + +
+ + + + + +
-[@stdlib/math/base/special/ceilsd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceilsd +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/roundsd..h" +#include -[@stdlib/math/base/special/floorsd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/floorsd +int main( void ) { + const double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 }; -[@stdlib/math/base/special/round]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/round + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_roundsd( x[ i ], -2, 10 ); + printf( "roundsd(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
-[@stdlib/math/base/special/truncsd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/truncsd + + + + +
+ +
+ + + + + +
+ + diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/benchmark.native.js new file mode 100644 index 000000000000..90cb77325690 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/benchmark.native.js @@ -0,0 +1,61 @@ +/** +* @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 tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var roundsd = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( roundsd instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -5.0e6, 5.0e6 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = roundsd( x[ i%x.length ], 2, 2 ); + 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/math/base/special/roundsd/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/c/native/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/c/native/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/math/base/special/roundsd/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..5a82f491f244 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/benchmark/c/native/benchmark.c @@ -0,0 +1,133 @@ +/** +* @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/math/base/special/roundsd.h" +#include +#include +#include +#include +#include + +#define NAME "roundsd" +#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 ) { + double elapsed; + double t; + double v; + double y; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + v = ( 1000.0*rand_double() ) - 500.0; + y = stdlib_base_roundsd( v, 5, 10 ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\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/math/base/special/roundsd/binding.gyp b/lib/node_modules/@stdlib/math/base/special/roundsd/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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/math/base/special/roundsd/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/roundsd/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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/math/base/special/roundsd/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/roundsd/examples/c/example.c new file mode 100644 index 000000000000..c6aeb5042ec3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @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/math/base/special/roundsd.h" +#include + +int main( void ) { + const double x[] = { 3.143546, -3.142635, 0.0, 0.0/0.0 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_roundsd( x[ i ], 2, 10 ); + printf( "roundsd(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/include.gypi b/lib/node_modules/@stdlib/math/base/special/roundsd/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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 + +/** +* Rounds a numeric value to the nearest number with \\(n\\) significant figures. +*/ +double stdlib_base_roundsd( const double x, const int32_t n, const int32_t b ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_ROUNDSD_H diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/lib/native.js b/lib/node_modules/@stdlib/math/base/special/roundsd/lib/native.js new file mode 100644 index 000000000000..5fe025744db7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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 // + +/** +* Rounds a numeric value to the nearest number with \\(n\\) significant figures. +* +* @private +* @param {number} x - input value +* @param {PositiveInteger} n - number of significant figures +* @param {PositiveInteger} b - base +* @returns {number} rounded value +* +* @example +* var v = roundsd( 3.141592653589793, 3, 10 ); +* // returns 3.14 +* +* @example +* var v = roundsd( 3.141592653589793, 1, 10 ); +* // returns 3.0 +* +* @example +* var v = roundsd( 12368.0, 2, 10 ); +* // returns 12000.0 +* +* @example +* var v = roundsd( 0.0313, 2, 2 ); +* // returns 0.03125 +*/ +function roundsd( x, n, b ) { + return addon( x, n, b ); +} + + +// EXPORTS // + +module.exports = roundsd; diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/manifest.json b/lib/node_modules/@stdlib/math/base/special/roundsd/manifest.json new file mode 100644 index 000000000000..ddebb5155941 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/manifest.json @@ -0,0 +1,102 @@ +{ + "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": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/ternary", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/floor", + "@stdlib/number/float64/base/exponent", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/round", + "@stdlib/math/base/assert/is-nan" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/floor", + "@stdlib/number/float64/base/exponent", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/round", + "@stdlib/math/base/assert/is-nan" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/floor", + "@stdlib/number/float64/base/exponent", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/round", + "@stdlib/math/base/assert/is-nan" + ] + } + ] + } diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/package.json b/lib/node_modules/@stdlib/math/base/special/roundsd/package.json index 0f457f87c52c..233856dad3ae 100644 --- a/lib/node_modules/@stdlib/math/base/special/roundsd/package.json +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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/math/base/special/roundsd/src/Makefile b/lib/node_modules/@stdlib/math/base/special/roundsd/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/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/math/base/special/roundsd/src/addon.c b/lib/node_modules/@stdlib/math/base/special/roundsd/src/addon.c new file mode 100644 index 000000000000..8d036bbc998f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/src/addon.c @@ -0,0 +1,22 @@ +/** +* @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/math/base/special/roundsd.h" +#include "stdlib/math/base/napi/ternary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_DII_D( stdlib_base_roundsd ) diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/src/main.c b/lib/node_modules/@stdlib/math/base/special/roundsd/src/main.c new file mode 100644 index 000000000000..4c6ee01a30c5 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/src/main.c @@ -0,0 +1,86 @@ +/** +* @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. +*/ + + +// MODULES // + +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/special/pow.h" +#include "stdlib/math/base/assert/is_infinite.h" +#include "stdlib/math/base/special/log10.h" +#include "stdlib/math/base/special/ln.h" +#include "stdlib/math/base/special/abs.h" +#include "stdlib/math/base/special/floor.h" +#include "stdlib/number/float64/base/exponent.h" +#include "stdlib/math/base/special/round.h" +#include + + +// MAIN // + +/** +* Rounds a numeric value to the nearest number with \\(n\\) significant figures. +* +* @param x input value +* @param n number of significant figures +* @param b base +* @returns rounded value +* +* @example +* double v = stdlib_base_roundsd( 3.141592653589793, 3, 10 ); +* // returns 3.14 +*/ +double stdlib_base_roundsd( const double x, const int32_t n, const int32_t b ) { + double exp; + double s; + double y; + + if ( stdlib_base_is_nan( x ) || n < 1 ) { + return 0.0/0.0; //NaN + } + if ( stdlib_base_is_infinite( x ) || x == 0.0 ) { + return x; + } + if ( b == 10 ) { + exp = stdlib_base_log10( stdlib_base_abs( x ) ); + } + else if ( b == 2 ) { + exp = stdlib_base_float64_exponent( stdlib_base_abs( x ) ); + } + else { + exp = stdlib_base_ln( stdlib_base_abs(x) ) / stdlib_base_ln( b ); + } + exp = stdlib_base_floor( exp - n + 1.0 ); + s = stdlib_base_pow( b, stdlib_base_abs( exp ) ); + + // Check for overflow: + if ( stdlib_base_is_infinite( s ) ) { + return x; + } + // To avoid numerical stability issues due to floating-point rounding error (e.g., 3.55/0.1-35.5 = -7.105427357601e-15 and 3.55*10-35.5 = 0), we must treat positive and negative exponents separately. + if ( exp < 0 ) { + y = stdlib_base_round( x * s ) / s; + } else { + y = stdlib_base_round( x / s ) * s; + } + // Check for overflow: + if ( stdlib_base_is_infinite( y ) ) { + return x; + } + return y; +} diff --git a/lib/node_modules/@stdlib/math/base/special/roundsd/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/roundsd/test/test.native.js new file mode 100644 index 000000000000..9c13e44ebb9e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/roundsd/test/test.native.js @@ -0,0 +1,236 @@ +/** +* @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 PI = require( '@stdlib/constants/float64/pi' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var roundsd = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( roundsd instanceof Error ) +}; + + +// FIXTURES // + +var base2 = require( './fixtures/julia/base_2_sigfigs_4.json' ); +var base16 = require( './fixtures/julia/base_16_sigfigs_4.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof roundsd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', opts, function test( t ) { + var v; + + v = roundsd( NaN, 2, 2 ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns `NaN` if provided `n < 1`', opts, function test( t ) { + var v; + + v = roundsd( PI, 0, 10 ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + v = roundsd( PI, -1, 10 ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns `NaN` if provided `b = +-infinity`', opts, function test( t ) { + var v; + + v = roundsd( PI, 2, PINF ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + v = roundsd( PI, 2, NINF ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns `NaN` if provided `b <= 0`', opts, function test( t ) { + var v; + + v = roundsd( PI, 2, 0 ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + v = roundsd( PI, 2, -1 ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', opts, function test( t ) { + var v = roundsd( PINF, 5, 10 ); + t.strictEqual( v, PINF, 'returns +infinity' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', opts, function test( t ) { + var v = roundsd( NINF, 3, 10 ); + t.strictEqual( v, NINF, 'returns -infinity' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v; + + v = roundsd( -0.0, 1, 10 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + v = roundsd( -0.0, 2, 10 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', opts, function test( t ) { + var v; + + v = roundsd( 0.0, 1, 10 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + v = roundsd( +0.0, 2, 10 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + t.end(); +}); + +tape( 'the function supports rounding a numeric value with a specified number of significant figures', opts, function test( t ) { + t.strictEqual( roundsd( PI, 1, 10 ), 3.0, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 1, 10 ), -3.0, 'returns expected value' ); + t.strictEqual( roundsd( PI, 2, 10 ), 3.1, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 2, 10 ), -3.1, 'returns expected value' ); + t.strictEqual( roundsd( PI, 3, 10 ), 3.14, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 3, 10 ), -3.14, 'returns expected value' ); + t.strictEqual( roundsd( 0.0, 2, 10 ), 0.0, 'returns expected value' ); + t.strictEqual( roundsd( 12368.0, 3, 10 ), 12400.0, 'returns expected value' ); + t.strictEqual( roundsd( -12368.0, 3, 10 ), -12400.0, 'returns expected value' ); + t.strictEqual( roundsd( 12368.0, 2, 10 ), 12000.0, 'returns expected value' ); + t.strictEqual( roundsd( -12368.0, 2, 10 ), -12000.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports rounding a numeric value with a specified number of significant figures (base 10)', opts, function test( t ) { + t.strictEqual( roundsd( PI, 1, 10 ), 3.0, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 1, 10 ), -3.0, 'returns expected value' ); + t.strictEqual( roundsd( PI, 2, 10 ), 3.1, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 2, 10 ), -3.1, 'returns expected value' ); + t.strictEqual( roundsd( PI, 3, 10 ), 3.14, 'returns expected value' ); + t.strictEqual( roundsd( -PI, 3, 10 ), -3.14, 'returns expected value' ); + t.strictEqual( roundsd( 0.0, 2, 10 ), 0.0, 'returns expected value' ); + t.strictEqual( roundsd( 12368.0, 3, 10 ), 12400.0, 'returns expected value' ); + t.strictEqual( roundsd( -12368.0, 3, 10 ), -12400.0, 'returns expected value' ); + t.strictEqual( roundsd( 12368.0, 2, 10 ), 12000.0, 'returns expected value' ); + t.strictEqual( roundsd( -12368.0, 2, 10 ), -12000.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports rounding a numeric value with a specified number of significant figures (base 2)', opts, function test( t ) { + var expected; + var x; + var y; + var i; + + t.strictEqual( roundsd( 0.0313, 1, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 2, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 3, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 4, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 5, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 6, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 7, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 8, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 9, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 10, 2 ), 0.03131103515625, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 11, 2 ), 0.03131103515625, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 12, 2 ), 0.0312957763671875, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 13, 2 ), 0.03130340576171875, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 14, 2 ), 0.031299591064453125, 'returns expected value' ); + + expected = base2.expected; + x = base2.x; + for ( i = 0; i < x.length; i++ ) { + y = roundsd( x[ i ], 4, 2 ); + t.strictEqual( y, expected[ i ], 'returns '+expected[i]+' when provided '+x[i] ); + } + t.end(); +}); + +tape( 'the function supports rounding a numeric value with a specified number of significant figures using an arbitrary base', opts, function test( t ) { + var expected; + var x; + var y; + var i; + + t.strictEqual( roundsd( 0.0313, 1, 16 ), 0.03125, 'returns expected value' ); + t.strictEqual( roundsd( 0.0313, 5, 16 ), 0.03130000829696655, 'returns expected value' ); + + expected = base16.expected; + x = base16.x; + for ( i = 0; i < x.length; i++ ) { + y = roundsd( x[ i ], 4, 16 ); + t.strictEqual( y, expected[ i ], 'returns '+expected[i]+' when provided '+x[i] ); + } + t.end(); +}); + +tape( 'if the function encounters overflow, the function returns the input value', opts, function test( t ) { + var x; + var v; + + x = 3.1468234343023397; + v = roundsd( x, 1000, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -3.1468234343023397; + v = roundsd( x, 1000, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = 9007199254740000; + v = roundsd( x, 320, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -9007199254740000; + v = roundsd( x, 320, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + t.end(); +});