diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/README.md b/lib/node_modules/@stdlib/math/base/special/truncn/README.md index 0e6b9b1df5d2..04e960cf0457 100644 --- a/lib/node_modules/@stdlib/math/base/special/truncn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/truncn/README.md @@ -89,6 +89,92 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/truncn.h" +``` + +#### stdlib_base_truncn( x, n ) + +Rounds a `numeric` value to the nearest multiple of `10^n` toward zero. + +```c +double y = stdlib_base_truncn( 3.141592653589793, -4 ); +// 3.1415 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **n**: `[in] int32_t` integer power of 10. + +```c +double stdlib_base_truncn( const double x, const int32_t n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/truncn.h" +#include + +int main( void ) { + const double x[] = { 3.141592653589793, -3.141592653589793, 2.731, 3.55555 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_truncn( x[ i ], -2 ); + printf( "truncn(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/benchmark.native.js new file mode 100644 index 000000000000..7a777d748df1 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/benchmark.native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var truncn = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncn instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = ( randu() * 1.0e7 ) - 5.0e6; + y = truncn( x, -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/truncn/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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/truncn/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..7ea87f678b3a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** +* Benchmark `truncn`. +*/ +#include "stdlib/math/base/special/truncn.h" +#include +#include +#include +#include +#include + +#define NAME "truncn" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +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 +*/ +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 +*/ +double tic() { + 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 +*/ +double rand_double() { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +double benchmark() { + double elapsed; + double t; + double v; + double y; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + v = ( 1.0e7 * rand_double() ) - 5.0e6; + y = stdlib_base_truncn( v, -2 ); + 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/truncn/binding.gyp b/lib/node_modules/@stdlib/math/base/special/truncn/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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/truncn/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/truncn/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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/truncn/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/truncn/examples/c/example.c new file mode 100644 index 000000000000..95002050298f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncn.h" +#include + +int main( void ) { + const double x[] = { 3.141592653589793, -3.141592653589793, 2.731, 3.55555 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_truncn( x[ i ], -2 ); + printf( "truncn(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/include.gypi b/lib/node_modules/@stdlib/math/base/special/truncn/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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 multiple of \\(10^n\\) toward zero. +*/ +double stdlib_base_truncn( const double x, const int32_t n ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_TRUNCN_H diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/lib/native.js b/lib/node_modules/@stdlib/math/base/special/truncn/lib/native.js new file mode 100644 index 000000000000..9ae5caf9bbfc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/lib/native.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds a numeric value to the nearest multiple of \\(10^n\\) toward zero. +* +* @private +* @param {number} x - input value +* @param {integer} n - integer power of `10` +* @returns {number} rounded value +* +* @example +* // Round a value to 4 decimal places: +* var v = truncn( 3.141592653589793, -4 ); +* // returns 3.1415 +* +* @example +* // If n = 0, `truncn` behaves like `trunc`: +* var v = truncn( 3.141592653589793, 0 ); +* // returns 3.0 +* +* @example +* // Round a value to the nearest thousand: +* var v = truncn( 12368.0, 3 ); +* // returns 12000.0 +*/ +function truncn( x, n ) { + return addon( x, n ); +} + + +// EXPORTS // + +module.exports = truncn; diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/manifest.json b/lib/node_modules/@stdlib/math/base/special/truncn/manifest.json new file mode 100644 index 000000000000..1f85b8ae0824 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/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/binary", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/trunc", + "@stdlib/math/base/special/pow", + "@stdlib/constants/float64/max-safe-integer", + "@stdlib/constants/float64/max-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent-subnormal", + "@stdlib/math/base/assert/is-infinite", + "@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/trunc", + "@stdlib/math/base/special/pow", + "@stdlib/constants/float64/max-safe-integer", + "@stdlib/constants/float64/max-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent-subnormal", + "@stdlib/math/base/assert/is-infinite", + "@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/trunc", + "@stdlib/math/base/special/pow", + "@stdlib/constants/float64/max-safe-integer", + "@stdlib/constants/float64/max-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent", + "@stdlib/constants/float64/min-base10-exponent-subnormal", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/assert/is-nan" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/src/Makefile b/lib/node_modules/@stdlib/math/base/special/truncn/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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/truncn/src/addon.c b/lib/node_modules/@stdlib/math/base/special/truncn/src/addon.c new file mode 100644 index 000000000000..4177ed439fbb --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/src/addon.c @@ -0,0 +1,22 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncn.h" +#include "stdlib/math/base/napi/binary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_DI_D( stdlib_base_truncn ) diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/src/main.c b/lib/node_modules/@stdlib/math/base/special/truncn/src/main.c new file mode 100644 index 000000000000..da60bfa0ffbc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/src/main.c @@ -0,0 +1,138 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncn.h" +#include "stdlib/math/base/special/trunc.h" +#include "stdlib/math/base/assert/is_infinite.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/special/abs.h" +#include "stdlib/math/base/special/pow.h" +#include "stdlib/constants/float64/max_safe_integer.h" +#include "stdlib/constants/float64/max_base10_exponent.h" +#include "stdlib/constants/float64/min_base10_exponent.h" +#include "stdlib/constants/float64/min_base10_exponent_subnormal.h" +#include + +static const double MAX_INT = STDLIB_CONSTANT_FLOAT64_MAX_SAFE_INTEGER + 1.0; +static const double HUGE_VALUE = 1.0e+308; + +/** +* Rounds a numeric value to the nearest multiple of \\(10^n\\) toward zero. +* +* ## Method +* +* 1. If \\(|x| <= 2^{53}\\) and \\(|n| <= 308\\), we can use the formula +* +* ```tex +* \operatorname{truncn}(x,n) = \frac{\operatorname{trunc}(x \cdot 10^{-n})}{10^{-n}} +* ``` +* +* which shifts the decimal to the nearest multiple of \\(10^n\\), performs a standard \\(\mathrm{trunc}\\) operation, and then shifts the decimal to its original position. +* +* +* +* If \\(x \cdot 10^{-n}\\) overflows, \\(x\\) lacks a sufficient number of decimal digits to have any effect when rounding. Accordingly, the rounded value is \\(x\\). +* +* +* +* +* +* Note that rescaling \\(x\\) can result in unexpected behavior due to the fact that most decimal fractions cannot be exactly represented as floating-point numbers. And further, rescaling can lead to slightly different fractional values, which, in turn, affects the result of \\(\mathrm{trunc}\\). +* +* +* +* 2. If \\(n > 308\\), we recognize that the maximum absolute double-precision floating-point number is \\(\approx 1.8\mbox{e}308\\) and, thus, the result of rounding any possible finite number \\(x\\) to the nearest \\(10^n\\) is \\(0\\). To ensure consistent behavior with \\(\operatorname{trunc}(x)\\), the sign of \\(x\\) is preserved. +* +* 3. If \\(n < -324\\), \\(n\\) exceeds the maximum number of possible decimal places (such as with subnormal numbers), and, thus, the rounded value is \\(x\\). +* +* 4. If \\(x > 2^{53}\\), \\(x\\) is **always** an integer (i.e., \\(x\\) has no decimal digits). If \\(n <= 0\\), the rounded value is \\(x\\). +* +* 5. If \\(n < -308\\), we let \\(m = n + 308\\) and modify the above formula to avoid overflow. +* +* ```tex +* \operatorname{truncn}(x,n) = \frac{\biggl(\frac{\operatorname{trunc}( (x \cdot 10^{308}) 10^{-m})}{10^{308}}\biggr)}{10^{-m}} +* ``` +* +* If overflow occurs, the rounded value is \\(x\\). +* +* ## Special Cases +* +* ```tex +* \begin{align*} +* \operatorname{truncn}(\mathrm{NaN}, n) &= \mathrm{NaN} \\ +* \operatorname{truncn}(x, \mathrm{NaN}) &= \mathrm{NaN} \\ +* \operatorname{truncn}(x, \pm\infty) &= \mathrm{NaN} \\ +* \operatorname{truncn}(\pm\infty, n) &= \pm\infty \\ +* \operatorname{truncn}(\pm 0, n) &= \pm 0 +* \end{align*} +* ``` +* +* @param x input value +* @param n integer power of `10` +* @return rounded value +* +* @example +* // Round a value to 4 decimal places: +* double v = stdlib_base_truncn( 3.141592653589793, -4 ); +* // returns 3.1415 +*/ +double stdlib_base_truncn( const double x, const int32_t n ) { + double s; + double y; + + if ( stdlib_base_is_nan( x ) ){ + return 0.0 / 0.0; // NaN + } + + if ( + // Handle infinites... + stdlib_base_is_infinite( x ) || + + // Handle +-0... + x == 0.0 || + + // If `n` exceeds the maximum number of feasible decimal places (such as with subnormal numbers), nothing to truncate... + n < STDLIB_CONSTANT_FLOAT64_MIN_BASE10_EXPONENT_SUBNORMAL || + + // If `|x|` is large enough, no decimals to truncate... + ( stdlib_base_abs( x ) > MAX_INT && n <= 0 ) + ) { + return x; + } + + // The maximum absolute double is ~1.8e308. Accordingly, any possible positive finite `x` rounded to the nearest >=10^309 is zero. + if ( n > STDLIB_CONSTANT_FLOAT64_MAX_BASE10_EXPONENT ){ + return 0.0 * x; // preserve the sign (same behavior as trunc) + } + + // If we overflow, return `x`, as the number of digits to the right of the decimal is too small (i.e., `x` is too large / lacks sufficient fractional precision) for there to be any effect when rounding... + if ( n < STDLIB_CONSTANT_FLOAT64_MIN_BASE10_EXPONENT ){ + s = stdlib_base_pow( 10.0, -( n + STDLIB_CONSTANT_FLOAT64_MAX_BASE10_EXPONENT ) ); + y = ( x * HUGE_VALUE ) * s; // order of operation matters! + if ( stdlib_base_is_infinite( y ) ){ + return x; + } + return ( stdlib_base_trunc( y ) / HUGE_VALUE ) / s; + } + s = stdlib_base_pow( 10.0, -n ); + y = x * s; + if ( stdlib_base_is_infinite( y ) ){ + return x; + } + return stdlib_base_trunc( y ) / s; +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncn/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/truncn/test/test.native.js new file mode 100644 index 000000000000..7dd564ee1555 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncn/test/test.native.js @@ -0,0 +1,261 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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 EPS = require( '@stdlib/constants/float64/eps' ); +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var abs = require( '@stdlib/math/base/special/abs' ); +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 truncn = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncn instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof truncn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', opts, function test( t ) { + var v; + + v = truncn( NaN, -2 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', opts, function test( t ) { + var v = truncn( PINF, 5 ); + t.strictEqual( v, PINF, 'returns +infinity' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', opts, function test( t ) { + var v = truncn( NINF, -3 ); + t.strictEqual( v, NINF, 'returns -infinity' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v; + + v = truncn( -0.0, 0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + v = truncn( -0.0, -2 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + v = truncn( -0.0, 2 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', opts, function test( t ) { + var v; + + v = truncn( 0.0, 0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + v = truncn( +0.0, -2 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + v = truncn( +0.0, 2 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + t.end(); +}); + +tape( 'the function supports rounding a numeric value to a desired number of decimals', opts, function test( t ) { + t.strictEqual( truncn( PI, -4 ), 3.1415, 'equals 3.1415' ); + t.strictEqual( truncn( -PI, -2 ), -3.14, 'equals -3.14' ); + t.strictEqual( truncn( 9.99999, -2 ), 9.99, 'equals 9.99' ); + t.strictEqual( truncn( -9.99999, -2 ), -9.99, 'equals -9.99' ); + t.strictEqual( truncn( 0.0, 2 ), 0.0, 'equals 0' ); + t.strictEqual( truncn( 12368.0, -3 ), 12368.0, 'equals 12368' ); + t.strictEqual( truncn( -12368.0, -3 ), -12368.0, 'equals -12368' ); + t.end(); +}); + +tape( 'the function supports rounding a numeric value to a desired number of digits', opts, function test( t ) { + t.strictEqual( truncn( PI, 4 ), 0.0, 'equals 0' ); + t.strictEqual( truncn( 12368.0, 3 ), 12000.0, 'equals 12000' ); + t.strictEqual( truncn( 12363.0, 1 ), 12360.0, 'equals 12360' ); + t.strictEqual( isPositiveZero( truncn( PI, 3 ) ), true, 'equals +0' ); + t.strictEqual( truncn( -12368.0, 3 ), -12000.0, 'equals -12000' ); + t.strictEqual( truncn( -12368.0, 1 ), -12360.0, 'equals -12360' ); + t.end(); +}); + +tape( 'the function returns the input value if provided an `n` which is less than the minimum decimal exponential (-324)', opts, function test( t ) { + var exp; + var n; + var x; + var v; + var i; + for ( i = 0; i < 100; i++ ) { + exp = round( randu()*616.0 ) - 308; + x = (1.0+randu()) * pow( 10.0, exp ); + n = -(round( randu()*1000.0 ) + 325); + v = truncn( x, n ); + t.strictEqual( v, x, 'returns input value when provided x='+x+', n='+n+'.' ); + } + t.end(); +}); + +tape( 'if `x` is too large a double to have decimals and `n < 0`, the input value is returned', opts, function test( t ) { + var sign; + var exp; + var x; + var n; + var v; + var i; + for ( i = 0; i < 100; i++ ) { + sign = ( randu()<0.5 ) ? -1.0 : 1.0; + exp = 54 + round( randu()*254.0 ); + x = sign * (1.0+randu()) * pow( 10.0, exp ); + n = -( round( randu()*324.0) ); + v = truncn( x, n ); + t.strictEqual( x, v, ' returns input value when provided x='+x+', n='+n+'.' ); + } + t.end(); +}); + +tape( 'if `n > 308` and `x < 0`, the function returns `-0`', opts, function test( t ) { + var exp; + var x; + var n; + var v; + var i; + for ( i = 0; i < 100; i++ ) { + exp = round( randu()*307.0 ); + x = -(1.0+randu()) * pow( 10.0, exp ); + n = round( randu()*100.0 ) + 309; + v = truncn( x, n ); + t.strictEqual( isNegativeZero( v ), true, ' returns -0 when provided x='+x+', n='+n+'.' ); + } + t.end(); +}); + +tape( 'if `n > 308` and `x > 0`, the function returns `+0`', opts, function test( t ) { + var exp; + var x; + var n; + var v; + var i; + for ( i = 0; i < 100; i++ ) { + exp = round( randu()*307.0 ); + x = (1.0+randu()) * pow( 10.0, exp ); + n = round( randu()*100.0 ) + 309; + v = truncn( x, n ); + t.strictEqual( isPositiveZero( v ), true, ' returns +0 when provided x='+x+', n='+n+'.' ); + } + t.end(); +}); + +tape( 'the function supports rounding very small numbers (including subnormals)', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var n; + var v; + var i; + + x = 3.1468234343023397 * pow( 10.0, -308 ); + + n = []; + for ( i = -308; i > -325; i-- ) { + n.push( i ); + } + expected = [ + 3e-308, + 3.1e-308, + 3.14e-308, + 3.146e-308, + 3.1468e-308, + 3.14682e-308, + 3.146823e-308, + 3.1468234e-308, + 3.14682343e-308, + 3.146823434e-308, + 3.1468234343e-308, + 3.14682343430e-308, + 3.146823434302e-308, + 3.1468234343023e-308, + 3.14682343430234e-308, // 3.1468234343023397e-308 * 1e308 = 3.14682343430234 + 3.146823434302340e-308, // 3.1468234343023397e-308 * 1e308 = 3.14682343430234 + 3.1468234343023397e-308 + ]; + + for ( i = 0; i < n.length; i++ ) { + v = truncn( x, n[i] ); + if ( v === expected[i] ) { + t.strictEqual( v, expected[ i ], 'returns '+expected[i]+' when provided x='+x+' and n='+n[i]+'.' ); + } else { + delta = abs( v - expected[i] ); + tol = EPS * abs( expected[i] ); + t.strictEqual( delta <= tol, true, 'x: '+x+'. n: '+n[i]+'. v: '+v+'. expected: '+expected[i]+'. delta: '+delta+'. tol: '+tol ); + } + } + 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 = truncn( x, -314 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -3.1468234343023397; + v = truncn( x, -314 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = 9007199254740000; + v = truncn( x, -300 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -9007199254740000; + v = truncn( x, -300 ); + t.strictEqual( v, x, 'returns the input value' ); + + t.end(); +});