From 21c848b7209b8d4f3c9e245c36b290c5edd6a943 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Jul 2024 18:38:54 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 36 ++++ base/special/truncsd/README.md | 106 ++++++++++- .../truncsd/benchmark/benchmark.native.js | 60 ++++++ .../truncsd/benchmark/c/native/Makefile | 146 ++++++++++++++ .../truncsd/benchmark/c/native/benchmark.c | 136 +++++++++++++ base/special/truncsd/binding.gyp | 170 +++++++++++++++++ base/special/truncsd/docs/repl.txt | 12 +- base/special/truncsd/docs/types/index.d.ts | 10 +- base/special/truncsd/docs/types/test.ts | 15 -- base/special/truncsd/examples/c/Makefile | 146 ++++++++++++++ base/special/truncsd/examples/c/example.c | 34 ++++ base/special/truncsd/examples/index.js | 2 +- base/special/truncsd/include.gypi | 53 ++++++ .../stdlib/math/base/special/truncsd.h | 40 ++++ base/special/truncsd/lib/index.js | 6 +- base/special/truncsd/lib/main.js | 34 ++-- base/special/truncsd/lib/native.js | 60 ++++++ base/special/truncsd/manifest.json | 96 ++++++++++ base/special/truncsd/src/Makefile | 70 +++++++ base/special/truncsd/src/addon.c | 23 +++ base/special/truncsd/src/main.c | 81 ++++++++ base/special/truncsd/test/test.js | 43 ++--- base/special/truncsd/test/test.native.js | 180 ++++++++++++++++++ 23 files changed, 1467 insertions(+), 92 deletions(-) create mode 100644 base/special/truncsd/benchmark/benchmark.native.js create mode 100644 base/special/truncsd/benchmark/c/native/Makefile create mode 100644 base/special/truncsd/benchmark/c/native/benchmark.c create mode 100644 base/special/truncsd/binding.gyp create mode 100644 base/special/truncsd/examples/c/Makefile create mode 100644 base/special/truncsd/examples/c/example.c create mode 100644 base/special/truncsd/include.gypi create mode 100644 base/special/truncsd/include/stdlib/math/base/special/truncsd.h create mode 100644 base/special/truncsd/lib/native.js create mode 100644 base/special/truncsd/manifest.json create mode 100644 base/special/truncsd/src/Makefile create mode 100644 base/special/truncsd/src/addon.c create mode 100644 base/special/truncsd/src/main.c create mode 100644 base/special/truncsd/test/test.native.js diff --git a/CHANGELOG.md b/CHANGELOG.md index a5809c4d4..6358bfa74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5161,6 +5161,39 @@ A total of 2 issues were closed in this release: +
+ +#### [@stdlib/math/base/special/truncsd](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/truncsd) + +
+ +
+ +##### Features + +- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3) - add C implementation for `math/base/special/truncsd` [(#2666)](https://github.com/stdlib-js/stdlib/pull/2666) + +
+ + + +
+ +##### BREAKING CHANGES + +- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3): add C implementation for `math/base/special/truncsd` +- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3): The third argument 'b' in the JavaScript implementation of `truncsd` is now mandatory. To migrate, explicitly supply the old default value of `10` as the third argument. + +
+ + + +
+ +
+ + +
#### [@stdlib/math/base/special/vercos](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/vercos) @@ -5514,6 +5547,8 @@ This release closes the following issue: ### BREAKING CHANGES +- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3): add C implementation for `math/base/special/truncsd` +- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3): The third argument 'b' in the JavaScript implementation of `truncsd` is now mandatory. To migrate, explicitly supply the old default value of `10` as the third argument. - [`5df976a`](https://github.com/stdlib-js/stdlib/commit/5df976abacaaf3082890fa852e40edfdf1b79f4b): update namespace TypeScript declarations - [`5df976a`](https://github.com/stdlib-js/stdlib/commit/5df976abacaaf3082890fa852e40edfdf1b79f4b): base parameter is no longer optional @@ -5626,6 +5661,7 @@ A total of 29 people contributed to this release. Thank you to the following con
+- [`fce4265`](https://github.com/stdlib-js/stdlib/commit/fce42651903b96cc6a0f26e84afc812fa4ea94b3) - **feat:** add C implementation for `math/base/special/truncsd` [(#2666)](https://github.com/stdlib-js/stdlib/pull/2666) _(by Gunj Joshi)_ - [`4a2534a`](https://github.com/stdlib-js/stdlib/commit/4a2534a22c2ead42a6318bed2fce221286f9f7a8) - **feat:** add C implementation for `math/base/special/fresnelc` [(#2680)](https://github.com/stdlib-js/stdlib/pull/2680) _(by Gunj Joshi)_ - [`c476e32`](https://github.com/stdlib-js/stdlib/commit/c476e32e617de04644d9fbf399a34f80661778ea) - **feat:** add C implementation for `math/base/special/fresnels` [(#2675)](https://github.com/stdlib-js/stdlib/pull/2675) _(by Gunj Joshi)_ - [`7e04d9e`](https://github.com/stdlib-js/stdlib/commit/7e04d9e27fb5008c1cbc6e45e08ea6ad4b8993d2) - **refactor:** use max-safe-nth-factorial package [(#2676)](https://github.com/stdlib-js/stdlib/pull/2676 ) _(by Gunj Joshi)_ diff --git a/base/special/truncsd/README.md b/base/special/truncsd/README.md index ea89af61a..c75dc566c 100644 --- a/base/special/truncsd/README.md +++ b/base/special/truncsd/README.md @@ -30,25 +30,21 @@ limitations under the License. var truncsd = require( '@stdlib/math/base/special/truncsd' ); ``` -#### truncsd( x, n\[, b] ) +#### truncsd( x, n, b ) Rounds a `numeric` value to the nearest `number` toward zero with `n` significant figures. ```javascript -var v = truncsd( 3.141592653589793, 5 ); +var v = truncsd( 3.141592653589793, 5, 10 ); // returns 3.1415 -v = truncsd( 3.141592653589793, 1 ); +v = truncsd( 3.141592653589793, 1, 10 ); // returns 3.0 -v = truncsd( 12368.0, 2 ); +v = truncsd( 12368.0, 2, 10 ); // returns 12000.0 -``` - -The default base is `10` (decimal). To round using a different base, provide a third argument. -```javascript -var v = truncsd( 0.0313, 2, 2 ); +v = truncsd( 0.0313, 2, 2 ); // returns 0.03125 ``` @@ -78,7 +74,7 @@ var i; for ( i = 0; i < 100; i++ ) { x = (randu()*10000.0) - 5000.0; - y = truncsd( x, 5 ); + y = truncsd( x, 5, 10 ); console.log( 'x: %d. Rounded: %d.', x, y ); } ``` @@ -87,6 +83,96 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/truncsd.h" +``` + +#### stdlib_base_truncsd( x, n, b ) + +Rounds a `numeric` value to the nearest `number` toward negative infinity with `n` significant figures. + +```c +double out = stdlib_base_truncsd( 3.141592653589793, 5, 10 ); +// returns 3.1415 +``` + +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_truncsd( const double x, const int32_t n, const int32_t b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/truncsd.h" +#include +#include + +int main( void ) { + const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 }; + const int32_t n[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; + const int32_t b[] = { 20, 19, 18, 17, 16, 15, 14, 13, 12, 11 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_truncsd( x[ i ], n[ i ], b[ i ] ); + printf( "truncsd(%lf, %d, %d) = %lf\n", x[ i ], n[ i ], b[ i ], v ); + } +} +``` + +
+ + + +
+ + +
diff --git a/base/special/truncsd/benchmark/benchmark.native.js b/base/special/truncsd/benchmark/benchmark.native.js new file mode 100644 index 000000000..6190ffc2c --- /dev/null +++ b/base/special/truncsd/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( './../../../../base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var truncsd = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncsd 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 = truncsd( x, 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/base/special/truncsd/benchmark/c/native/Makefile b/base/special/truncsd/benchmark/c/native/Makefile new file mode 100644 index 000000000..f69e9da2b --- /dev/null +++ b/base/special/truncsd/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/base/special/truncsd/benchmark/c/native/benchmark.c b/base/special/truncsd/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..6b8ddf5b8 --- /dev/null +++ b/base/special/truncsd/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 `truncsd`. +*/ +#include "stdlib/math/base/special/truncsd.h" +#include +#include +#include +#include +#include + +#define NAME "truncsd" +#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 x; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( 1.0e7 * rand_double() ) - 5.0e6; + y = stdlib_base_truncsd( x, 2, 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/base/special/truncsd/binding.gyp b/base/special/truncsd/binding.gyp new file mode 100644 index 000000000..ec3992233 --- /dev/null +++ b/base/special/truncsd/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/base/special/truncsd/docs/repl.txt b/base/special/truncsd/docs/repl.txt index 979cba4ea..5aefcf254 100644 --- a/base/special/truncsd/docs/repl.txt +++ b/base/special/truncsd/docs/repl.txt @@ -1,5 +1,5 @@ -{{alias}}( x, n[, b] ) +{{alias}}( x, n, b ) Rounds a numeric value to the nearest number toward zero with `n` significant figures. @@ -11,8 +11,8 @@ n: integer Number of significant figures. Must be greater than 0. - b: integer (optional) - Base. Must be greater than 0. Default: 10. + b: integer + Base. Must be greater than 0. Returns ------- @@ -21,11 +21,11 @@ Examples -------- - > var y = {{alias}}( 3.14159, 5 ) + > var y = {{alias}}( 3.14159, 5, 10 ) 3.1415 - > y = {{alias}}( 3.14159, 1 ) + > y = {{alias}}( 3.14159, 1, 10 ) 3.0 - > y = {{alias}}( 12368.0, 2 ) + > y = {{alias}}( 12368.0, 2, 10 ) 12000.0 > y = {{alias}}( 0.0313, 2, 2 ) 0.03125 diff --git a/base/special/truncsd/docs/types/index.d.ts b/base/special/truncsd/docs/types/index.d.ts index 1450cce46..5385b26d4 100644 --- a/base/special/truncsd/docs/types/index.d.ts +++ b/base/special/truncsd/docs/types/index.d.ts @@ -23,26 +23,26 @@ * * @param x - input value * @param n - number of significant figures -* @param b - integer base (default: 10) +* @param b - integer base * @returns rounded value * * @example -* var v = truncsd( 3.141592653589793, 5 ); +* var v = truncsd( 3.141592653589793, 5, 10 ); * // returns 3.1415 * * @example -* var v = truncsd( 3.141592653589793, 1 ); +* var v = truncsd( 3.141592653589793, 1, 10 ); * // returns 3.0 * * @example -* var v = truncsd( 12368.0, 2 ); +* var v = truncsd( 12368.0, 2, 10 ); * // returns 12000.0 * * @example * var v = truncsd( 0.0313, 2, 2 ); * // returns 0.03125 */ -declare function truncsd( x: number, n: number, b?: number ): number; +declare function truncsd( x: number, n: number, b: number ): number; // EXPORTS // diff --git a/base/special/truncsd/docs/types/test.ts b/base/special/truncsd/docs/types/test.ts index b4a00e868..3c85dccab 100644 --- a/base/special/truncsd/docs/types/test.ts +++ b/base/special/truncsd/docs/types/test.ts @@ -24,25 +24,10 @@ import truncsd = require( './index' ); // The function returns a number... { truncsd( 3.141592653589793, 4, 10 ); // $ExpectType number - truncsd( 3.141592653589793, 4 ); // $ExpectType number } // The compiler throws an error if the function is provided values other than numbers... { - truncsd( true, 3 ); // $ExpectError - truncsd( false, 2 ); // $ExpectError - truncsd( '5', 1 ); // $ExpectError - truncsd( [], 1 ); // $ExpectError - truncsd( {}, 2 ); // $ExpectError - truncsd( ( x: number ): number => x, 2 ); // $ExpectError - - truncsd( 9, true ); // $ExpectError - truncsd( 9, false ); // $ExpectError - truncsd( 5, '5' ); // $ExpectError - truncsd( 8, [] ); // $ExpectError - truncsd( 9, {} ); // $ExpectError - truncsd( 8, ( x: number ): number => x ); // $ExpectError - truncsd( true, 3, 2 ); // $ExpectError truncsd( false, 2, 2 ); // $ExpectError truncsd( '5', 1, 2 ); // $ExpectError diff --git a/base/special/truncsd/examples/c/Makefile b/base/special/truncsd/examples/c/Makefile new file mode 100644 index 000000000..6aed70daf --- /dev/null +++ b/base/special/truncsd/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/base/special/truncsd/examples/c/example.c b/base/special/truncsd/examples/c/example.c new file mode 100644 index 000000000..9fc8e1a0a --- /dev/null +++ b/base/special/truncsd/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @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/truncsd.h" +#include +#include + +int main( void ) { + const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 }; + const int32_t n[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; + const int32_t b[] = { 20, 19, 18, 17, 16, 15, 14, 13, 12, 11 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_truncsd( x[ i ], n[ i ], b[ i ] ); + printf( "truncsd(%lf, %d, %d) = %lf\n", x[ i ], n[ i ], b[ i ], v ); + } +} diff --git a/base/special/truncsd/examples/index.js b/base/special/truncsd/examples/index.js index 586854a3c..98dac5f1b 100644 --- a/base/special/truncsd/examples/index.js +++ b/base/special/truncsd/examples/index.js @@ -27,6 +27,6 @@ var i; for ( i = 0; i < 100; i++ ) { x = (randu()*10000.0) - 5000.0; - y = truncsd( x, 5 ); + y = truncsd( x, 5, 10 ); console.log( 'x: %d. Rounded: %d.', x, y ); } diff --git a/base/special/truncsd/include.gypi b/base/special/truncsd/include.gypi new file mode 100644 index 000000000..575cb043c --- /dev/null +++ b/base/special/truncsd/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 number toward zero with \\(n\\) significant figures. +*/ +double stdlib_base_truncsd( const double x, const int32_t n, const int32_t b ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_TRUNCSD_H diff --git a/base/special/truncsd/lib/index.js b/base/special/truncsd/lib/index.js index dc5a73079..36cc8611e 100644 --- a/base/special/truncsd/lib/index.js +++ b/base/special/truncsd/lib/index.js @@ -26,13 +26,13 @@ * @example * var truncsd = require( '@stdlib/math/base/special/truncsd' ); * -* var v = truncsd( 3.141592653589793, 5 ); +* var v = truncsd( 3.141592653589793, 5, 10 ); * // returns 3.1415 * -* v = truncsd( 3.141592653589793, 1 ); +* v = truncsd( 3.141592653589793, 1, 10 ); * // returns 3.0 * -* v = truncsd( 12368.0, 2 ); +* v = truncsd( 12368.0, 2, 10 ); * // returns 12000.0 * * v = truncsd( 0.0313, 2, 2 ) diff --git a/base/special/truncsd/lib/main.js b/base/special/truncsd/lib/main.js index 9474e4905..71ab612b7 100644 --- a/base/special/truncsd/lib/main.js +++ b/base/special/truncsd/lib/main.js @@ -38,19 +38,19 @@ var trunc = require( './../../../../base/special/trunc' ); * * @param {number} x - input value * @param {PositiveInteger} n - number of significant figures -* @param {PositiveInteger} [b=10] - base +* @param {PositiveInteger} b - base * @returns {number} rounded value * * @example -* var v = truncsd( 3.141592653589793, 5 ); +* var v = truncsd( 3.141592653589793, 5, 10 ); * // returns 3.1415 * * @example -* var v = truncsd( 3.141592653589793, 1 ); +* var v = truncsd( 3.141592653589793, 1, 10 ); * // returns 3.0 * * @example -* var v = truncsd( 12368.0, 2 ); +* var v = truncsd( 12368.0, 2, 10 ); * // returns 12000.0 * * @example @@ -58,7 +58,6 @@ var trunc = require( './../../../../base/special/trunc' ); * // returns 0.03125 */ function truncsd( x, n, b ) { - var base; var exp; var s; var y; @@ -66,36 +65,27 @@ function truncsd( x, n, b ) { isnan( x ) || isnan( n ) || n < 1 || - isInfinite( n ) + isInfinite( n ) || + isnan( b ) || + b <= 0 || + isInfinite( b ) ) { return NaN; } - if ( arguments.length > 2 ) { - if ( - isnan( b ) || - b <= 0 || - isInfinite( b ) - ) { - return NaN; - } - base = b; - } else { - base = 10; - } if ( isInfinite( x ) || x === 0.0 ) { return x; } - if ( base === 10 ) { + if ( b === 10 ) { exp = log10( abs( x ) ); } - else if ( base === 2 ) { + else if ( b === 2 ) { exp = exponent( abs( x ) ); } else { - exp = ln( abs(x) ) / ln( base ); + exp = ln( abs(x) ) / ln( b ); } exp = floor( exp - n + 1.0 ); - s = pow( base, abs( exp ) ); + s = pow( b, abs( exp ) ); // Check for overflow: if ( isInfinite( s ) ) { diff --git a/base/special/truncsd/lib/native.js b/base/special/truncsd/lib/native.js new file mode 100644 index 000000000..b04a16a36 --- /dev/null +++ b/base/special/truncsd/lib/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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds a numeric value to the nearest number toward zero 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 = truncsd( 3.141592653589793, 5, 10 ); +* // returns 3.1415 +* +* @example +* var v = truncsd( 3.141592653589793, 1, 10 ); +* // returns 3.0 +* +* @example +* var v = truncsd( 12368.0, 2, 10 ); +* // returns 12000.0 +* +* @example +* var v = truncsd( 0.0313, 2, 2 ); +* // returns 0.03125 +*/ +function truncsd( x, n, b ) { + return addon( x, n, b ); +} + + +// EXPORTS // + +module.exports = truncsd; diff --git a/base/special/truncsd/manifest.json b/base/special/truncsd/manifest.json new file mode 100644 index 000000000..ed0abe597 --- /dev/null +++ b/base/special/truncsd/manifest.json @@ -0,0 +1,96 @@ +{ + "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/math/base/napi/ternary", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/trunc", + "@stdlib/number/float64/base/exponent" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/trunc", + "@stdlib/number/float64/base/exponent" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-infinite", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/log10", + "@stdlib/math/base/special/ln", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/trunc", + "@stdlib/number/float64/base/exponent" + ] + } + ] +} diff --git a/base/special/truncsd/src/Makefile b/base/special/truncsd/src/Makefile new file mode 100644 index 000000000..bcf18aa46 --- /dev/null +++ b/base/special/truncsd/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/base/special/truncsd/src/addon.c b/base/special/truncsd/src/addon.c new file mode 100644 index 000000000..7bac2de76 --- /dev/null +++ b/base/special/truncsd/src/addon.c @@ -0,0 +1,23 @@ +/** +* @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/truncsd.h" +#include "stdlib/math/base/napi/ternary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_DII_D( stdlib_base_truncsd ) diff --git a/base/special/truncsd/src/main.c b/base/special/truncsd/src/main.c new file mode 100644 index 000000000..df49b0246 --- /dev/null +++ b/base/special/truncsd/src/main.c @@ -0,0 +1,81 @@ +/** +* @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/truncsd.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/assert/is_infinite.h" +#include "stdlib/math/base/special/pow.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/math/base/special/trunc.h" +#include "stdlib/number/float64/base/exponent.h" +#include + +/** +* Rounds a numeric value to the nearest number toward zero with \\(n\\) significant figures. +* +* @param x input value +* @param n number of significant figures +* @param b base +* @return rounded value +* +* @example +* double out = stdlib_base_truncsd( 3.141592653589793, 5, 10 ); +* // returns 3.1415 +*/ +double stdlib_base_truncsd( 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 || b <= 0 ) { + 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( (double)b ); + } + exp = stdlib_base_floor( exp - (double)n + 1.0 ); + s = stdlib_base_pow( (double)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_trunc( x * s ) / s; + } else { + y = stdlib_base_trunc( x / s ) * s; + } + + // Check for overflow: + if ( stdlib_base_is_infinite( y ) ) { + return x; + } + return y; +} diff --git a/base/special/truncsd/test/test.js b/base/special/truncsd/test/test.js index ef3bb4e79..0a016b46b 100644 --- a/base/special/truncsd/test/test.js +++ b/base/special/truncsd/test/test.js @@ -41,13 +41,13 @@ tape( 'main export is a function', function test( t ) { tape( 'the function returns `NaN` if provided `NaN`', function test( t ) { var v; - v = truncsd( NaN, 2 ); + v = truncsd( NaN, 2, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); - v = truncsd( 12368.0, NaN ); + v = truncsd( 12368.0, NaN, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); - v = truncsd( NaN, NaN ); + v = truncsd( NaN, NaN, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); v = truncsd( NaN, NaN, 10 ); @@ -68,10 +68,10 @@ tape( 'the function returns `NaN` if provided `NaN`', function test( t ) { tape( 'the function returns `NaN` if provided `n = +-infinity`', function test( t ) { var v; - v = truncsd( PI, PINF ); + v = truncsd( PI, PINF, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); - v = truncsd( PI, NINF ); + v = truncsd( PI, NINF, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); t.end(); @@ -80,10 +80,10 @@ tape( 'the function returns `NaN` if provided `n = +-infinity`', function test( tape( 'the function returns `NaN` if provided `n < 1`', function test( t ) { var v; - v = truncsd( PI, 0 ); + v = truncsd( PI, 0, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); - v = truncsd( PI, -1 ); + v = truncsd( PI, -1, 10 ); t.strictEqual( isnan( v ), true, 'returns NaN' ); t.end(); @@ -114,13 +114,13 @@ tape( 'the function returns `NaN` if provided `b <= 0`', function test( t ) { }); tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { - var v = truncsd( PINF, 5 ); + var v = truncsd( PINF, 5, 10 ); t.strictEqual( v, PINF, 'returns +infinity' ); t.end(); }); tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { - var v = truncsd( NINF, 3 ); + var v = truncsd( NINF, 3, 10 ); t.strictEqual( v, NINF, 'returns -infinity' ); t.end(); }); @@ -128,10 +128,10 @@ tape( 'the function returns `-infinity` if provided `-infinity`', function test( tape( 'the function returns `-0` if provided `-0`', function test( t ) { var v; - v = truncsd( -0.0, 1 ); + v = truncsd( -0.0, 1, 10 ); t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); - v = truncsd( -0.0, 2 ); + v = truncsd( -0.0, 2, 10 ); t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); t.end(); @@ -140,32 +140,15 @@ tape( 'the function returns `-0` if provided `-0`', function test( t ) { tape( 'the function returns `+0` if provided `+0`', function test( t ) { var v; - v = truncsd( 0.0, 1 ); + v = truncsd( 0.0, 1, 10 ); t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); - v = truncsd( +0.0, 2 ); + v = truncsd( +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', function test( t ) { - t.strictEqual( truncsd( PI, 1 ), 3.0, 'returns expected value' ); - t.strictEqual( truncsd( -PI, 1 ), -3.0, 'returns expected value' ); - t.strictEqual( truncsd( PI, 2 ), 3.1, 'returns expected value' ); - t.strictEqual( truncsd( -PI, 2 ), -3.1, 'returns expected value' ); - t.strictEqual( truncsd( PI, 3 ), 3.14, 'returns expected value' ); - t.strictEqual( truncsd( -PI, 3 ), -3.14, 'returns expected value' ); - t.strictEqual( truncsd( PI, 5 ), 3.1415, 'returns expected value' ); - t.strictEqual( truncsd( -PI, 5 ), -3.1415, 'returns expected value' ); - t.strictEqual( truncsd( 0.0, 2 ), 0.0, 'returns expected value' ); - t.strictEqual( truncsd( 12368.0, 3 ), 12300.0, 'returns expected value' ); - t.strictEqual( truncsd( -12368.0, 3 ), -12300.0, 'returns expected value' ); - t.strictEqual( truncsd( 12368.0, 2 ), 12000.0, 'returns expected value' ); - t.strictEqual( truncsd( -12368.0, 2 ), -12000.0, 'returns expected value' ); - t.end(); -}); - tape( 'the function supports rounding a numeric value with a specified number of significant figures (base 10)', function test( t ) { t.strictEqual( truncsd( PI, 1, 10 ), 3.0, 'returns expected value' ); t.strictEqual( truncsd( -PI, 1, 10 ), -3.0, 'returns expected value' ); diff --git a/base/special/truncsd/test/test.native.js b/base/special/truncsd/test/test.native.js new file mode 100644 index 000000000..9d4b1d9f4 --- /dev/null +++ b/base/special/truncsd/test/test.native.js @@ -0,0 +1,180 @@ +/** +* @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 isnan = require( './../../../../base/assert/is-nan' ); +var isNegativeZero = require( './../../../../base/assert/is-negative-zero' ); +var isPositiveZero = require( './../../../../base/assert/is-positive-zero' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var truncsd = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncsd instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof truncsd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', opts, function test( t ) { + var v; + + v = truncsd( NaN, 2, 10 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `n < 1`', opts, function test( t ) { + var v; + + v = truncsd( PI, 0, 10 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = truncsd( PI, -1, 10 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `NaN` if provided `b <= 0`', opts, function test( t ) { + var v; + + v = truncsd( PI, 2, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = truncsd( PI, 2, -1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', opts, function test( t ) { + var v = truncsd( 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 = truncsd( 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 = truncsd( -0.0, 1, 10 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + + v = truncsd( -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 = truncsd( 0.0, 1, 10 ); + t.strictEqual( isPositiveZero( v ), true, 'returns +0' ); + + v = truncsd( +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 (base 10)', opts, function test( t ) { + t.strictEqual( truncsd( PI, 1, 10 ), 3.0, 'returns expected value' ); + t.strictEqual( truncsd( -PI, 1, 10 ), -3.0, 'returns expected value' ); + t.strictEqual( truncsd( PI, 2, 10 ), 3.1, 'returns expected value' ); + t.strictEqual( truncsd( -PI, 2, 10 ), -3.1, 'returns expected value' ); + t.strictEqual( truncsd( PI, 3, 10 ), 3.14, 'returns expected value' ); + t.strictEqual( truncsd( -PI, 3, 10 ), -3.14, 'returns expected value' ); + t.strictEqual( truncsd( PI, 5, 10 ), 3.1415, 'returns expected value' ); + t.strictEqual( truncsd( -PI, 5, 10 ), -3.1415, 'returns expected value' ); + t.strictEqual( truncsd( 0.0, 2, 10 ), 0.0, 'returns expected value' ); + t.strictEqual( truncsd( 12368.0, 3, 10 ), 12300.0, 'returns expected value' ); + t.strictEqual( truncsd( -12368.0, 3, 10 ), -12300.0, 'returns expected value' ); + t.strictEqual( truncsd( 12368.0, 2, 10 ), 12000.0, 'returns expected value' ); + t.strictEqual( truncsd( -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 ) { + t.strictEqual( truncsd( 0.0313, 1, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 2, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 3, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 4, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 5, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 6, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 7, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 8, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 9, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 10, 2 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 11, 2 ), 0.031280517578125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 12, 2 ), 0.0312957763671875, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 13, 2 ), 0.0312957763671875, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 14, 2 ), 0.031299591064453125, 'returns expected value' ); + 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 ) { + t.strictEqual( truncsd( 0.0313, 1, 16 ), 0.03125, 'returns expected value' ); + t.strictEqual( truncsd( 0.0313, 5, 16 ), 0.03129994869232178, 'returns expected value' ); + 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 = truncsd( x, 1000, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -3.1468234343023397; + v = truncsd( x, 1000, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = 9007199254740000; + v = truncsd( x, 320, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + x = -9007199254740000; + v = truncsd( x, 320, 10 ); + t.strictEqual( v, x, 'returns the input value' ); + + t.end(); +});