diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/README.md b/lib/node_modules/@stdlib/math/base/special/truncbf/README.md new file mode 100644 index 000000000000..d983bb1e017d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/README.md @@ -0,0 +1,224 @@ + + +# truncbf + +> Round a [single-precision floating-point number][ieee754] toward zero to `n` digits in base `b`. + +
+ +## Usage + +```javascript +var truncbf = require( '@stdlib/math/base/special/truncbf' ); +``` + +#### truncbf( x, n, b ) + +Rounds a [single-precision floating-point number][ieee754] toward zero to `n` digits in base `b`. + +```javascript +var v = truncbf( 3.14159, 2, 10 ); +// returns 3.140000104904175 + +v = truncbf( 3.14159, 3, 10 ); +// returns 3.1410000324249268 + +v = truncbf( 15.0, -1, 10 ); +// returns 10.0 + +v = truncbf( -3.14159, 2, 10 ); +// returns -3.140000104904175 +``` + +If provided `NaN` or a `base` of `0`, the function returns `NaN`. + +```javascript +var v = truncbf( NaN, 2, 10 ); +// returns NaN + +v = truncbf( 3.14, 2, 0 ); +// returns NaN +``` + +If provided `x = ±0` or `x = ±infinity`, the function returns `x`. + +```javascript +var PINF = require( '@stdlib/constants/float32/pinf' ); +var NINF = require( '@stdlib/constants/float32/ninf' ); + +var v = truncbf( 0.0, 2, 10 ); +// returns 0.0 + +v = truncbf( -0.0, 2, 10 ); +// returns -0.0 + +v = truncbf( PINF, 2, 10 ); +// returns Infinity + +v = truncbf( NINF, 2, 10 ); +// returns -Infinity +``` + +
+ + + +
+ +## Notes + +- This function is the [single-precision floating-point][ieee754] equivalent of [`truncb`][@stdlib/math/base/special/truncb]. + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var truncbf = require( '@stdlib/math/base/special/truncbf' ); + +var x; +var i; + +for ( i = 0; i < 100; i++ ) { + x = (randu() * 100.0) - 50.0; + console.log( 'truncbf(%d, 2, 10) = %d', x, truncbf( x, 2, 10 ) ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/truncbf.h" +``` + +#### stdlib_base_truncbf( x, n, b ) + +Rounds a [single-precision floating-point number][ieee754] toward zero to `n` digits in base `b`. + +```c +float y = stdlib_base_truncbf( 3.14159f, 2, 10 ); +// returns 3.14f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. +- **n**: `[in] int32_t` number of digits. +- **b**: `[in] int32_t` base. + +```c +float stdlib_base_truncbf( const float x, const int32_t n, const int32_t b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/truncbf.h" +#include + +int main( void ) { + const float x[] = { 3.14159f, -3.14159f, 15.0f, -15.0f }; + const int32_t n[] = { 2, 3, -1, 0 }; + const int32_t b = 10; + + float y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_truncbf( x[i], n[i], b ); + printf( "truncbf(%f, %d, %d) = %f\n", x[i], n[i], b, y ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.js new file mode 100644 index 000000000000..95b9e647947e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.js @@ -0,0 +1,75 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var trunc = require( '@stdlib/math/base/special/trunc' ); +var pkg = require( './../package.json' ).name; +var truncbf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = (randu() * 100.0) - 50.0; + y = truncbf( x, 2, 10 ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::built-in', function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = (randu() * 100.0) - 50.0; + + // Use stdlib trunc instead of Math.trunc: + y = trunc( x * 100.0 ) / 100.0; + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..89e1fb4e4121 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/benchmark.native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var truncbf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncbf 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() * 100.0) - 50.0; + y = truncbf( x, 2, 10 ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/Makefile new file mode 100644 index 000000000000..feaed035545d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/Makefile @@ -0,0 +1,153 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +#/ +# Makefile for compiling C benchmark programs. +# +# ## Notes +# +# - The default `BLAS` and `LAPACK` libraries used when compiling benchmark programs are OpenBLAS libraries. To use different libraries, set the `BLAS` and `LAPACK` environment variables. +# +# ```bash +# $ BLAS='/path/to/libblas.so' LAPACK='/path/to/liblapack.so' make +# ``` +# +#/ + +# 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 C source files. +# +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +#/ +$(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/truncbf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..f07cb4605a5a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/benchmark.c @@ -0,0 +1,134 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncbf.h" +#include +#include +#include +#include +#include +#include + +#define NAME "truncbf" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmark results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + float x; + float y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( rand_float() * 200.0f ) - 100.0f; + y = stdlib_base_truncbf( x, 2, 10 ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%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/truncbf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..92dabd53f5b9 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/native/Makefile @@ -0,0 +1,140 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +#/ +$(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/truncbf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..b186413c3f02 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/c/native/benchmark.c @@ -0,0 +1,134 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncbf.h" +#include +#include +#include +#include +#include +#include + +#define NAME "truncbf::native" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmark results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + float x; + float y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( rand_float() * 200.0f ) - 100.0f; + y = stdlib_base_truncbf( x, 2, 10 ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/julia/benchmark.jl b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/julia/benchmark.jl new file mode 100644 index 000000000000..9be320ec2b5e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/benchmark/julia/benchmark.jl @@ -0,0 +1,162 @@ +#!/usr/bin/env julia +# +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import BenchmarkTools +using Printf + +# Benchmark variables: +name = "truncbf"; +repeats = 3; + +""" + print_version() + +Prints the TAP version. + +# Examples + +``` julia +julia> print_version() +``` +""" +function print_version() + @printf( "TAP version 13\n" ); +end + +""" + print_summary( total, passing ) + +Prints the benchmark summary. + +# Arguments + +* `total`: total number of tests +* `passing`: number of passing tests + +# Examples + +``` julia +julia> print_summary( 3, 3 ) +``` +""" +function print_summary( total, 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" ); +end + +""" + print_results( elapsed ) + +Prints benchmark results. + +# Arguments + +* `elapsed`: elapsed time (in seconds) + +# Examples + +``` julia +julia> print_results( 0.5 ) +``` +""" +function print_results( elapsed ) + rate = 1.0 / elapsed; + @printf( " ---\n" ); + @printf( " iterations: 1\n" ); + @printf( " elapsed: %0.9f\n", elapsed ); + @printf( " rate: %0.9f\n", rate ); + @printf( " ...\n" ); +end + +""" + truncbf( x, n, b ) + +Rounds a single-precision floating-point number toward zero to `n` digits in base `b`. + +# Arguments + +* `x`: input value +* `n`: number of digits +* `b`: base + +# Returns + +* `y`: rounded value + +# Examples + +``` julia +julia> y = truncbf( 3.14159f0, 2, 10 ) +3.14f0 +``` +""" +function truncbf( x::Float32, n::Int32, b::Int32 ) + if x == 0.0f0 || isnan( x ) || isinf( x ) + return x; + end + if b == 0 + return NaN32; + end + s = Float64( b ) ^ Float64( n ); + y = trunc( Float64( x ) * s ) / s; + return Float32( y ); +end + +""" + benchmark() + +Runs the benchmark. + +# Examples + +``` julia +julia> benchmark() +``` +""" +function benchmark() + t = @timed truncbf( 3.14159f0, 2, Int32( 10 ) ); + return t.time; +end + +""" + main() + +Runs the benchmarks. + +# Examples + +``` julia +julia> main() +``` +""" +function main() + print_version(); + for i in 1:repeats + @printf( "# julia::%s\n", name ); + elapsed = benchmark(); + print_results( elapsed ); + @printf( "ok %d benchmark finished\n", i ); + end + print_summary( repeats, repeats ); +end + +main(); diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/truncbf/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/repl.txt new file mode 100644 index 000000000000..4f7347fb9e0d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/repl.txt @@ -0,0 +1,41 @@ + +{{alias}}( x, n, b ) + Rounds a single-precision floating-point number toward zero to `n` digits + in base `b`. + + Parameters + ---------- + x: number + Input value. + + n: integer + Number of digits. + + b: integer + Base. + + Returns + ------- + y: number + Rounded value. + + Examples + -------- + > var y = {{alias}}( 3.14159, 2, 10 ) + ~3.14 + > y = {{alias}}( 3.14159, 3, 10 ) + ~3.141 + > y = {{alias}}( 15.0, -1, 10 ) + 10.0 + > y = {{alias}}( -3.14159, 2, 10 ) + ~-3.14 + > y = {{alias}}( {{alias:@stdlib/constants/float32/pinf}}, 2, 10 ) + Infinity + > y = {{alias}}( {{alias:@stdlib/constants/float32/ninf}}, 2, 10 ) + -Infinity + > y = {{alias}}( NaN, 2, 10 ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/index.d.ts new file mode 100644 index 000000000000..ae573cb3f3bd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/index.d.ts @@ -0,0 +1,54 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Rounds a single-precision floating-point number toward zero to `n` digits in base `b`. +* +* @param x - input value +* @param n - number of digits +* @param b - base +* @returns rounded value +* +* @example +* var v = truncbf( 3.14159, 2, 10 ); +* // returns 3.140000104904175 +* +* @example +* var v = truncbf( 3.14159, 3, 10 ); +* // returns 3.1410000324249268 +* +* @example +* var v = truncbf( 15.0, -1, 10 ); +* // returns 10.0 +* +* @example +* var v = truncbf( -3.14159, 2, 10 ); +* // returns -3.140000104904175 +* +* @example +* var v = truncbf( NaN, 2, 10 ); +* // returns NaN +*/ +declare function truncbf( x: number, n: number, b: number ): number; + + +// EXPORTS // + +export = truncbf; diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/test.ts new file mode 100644 index 000000000000..48009cc82bec --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/docs/types/test.ts @@ -0,0 +1,64 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import truncbf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + truncbf( 3.14, 2, 10 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument that is not a number... +{ + truncbf( true, 2, 10 ); // $ExpectError + truncbf( false, 2, 10 ); // $ExpectError + truncbf( '5', 2, 10 ); // $ExpectError + truncbf( [], 2, 10 ); // $ExpectError + truncbf( {}, 2, 10 ); // $ExpectError + truncbf( ( x: number ): number => x, 2, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument that is not a number... +{ + truncbf( 3.14, true, 10 ); // $ExpectError + truncbf( 3.14, false, 10 ); // $ExpectError + truncbf( 3.14, '5', 10 ); // $ExpectError + truncbf( 3.14, [], 10 ); // $ExpectError + truncbf( 3.14, {}, 10 ); // $ExpectError + truncbf( 3.14, ( x: number ): number => x, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument that is not a number... +{ + truncbf( 3.14, 2, true ); // $ExpectError + truncbf( 3.14, 2, false ); // $ExpectError + truncbf( 3.14, 2, '5' ); // $ExpectError + truncbf( 3.14, 2, [] ); // $ExpectError + truncbf( 3.14, 2, {} ); // $ExpectError + truncbf( 3.14, 2, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + truncbf(); // $ExpectError + truncbf( 3.14 ); // $ExpectError + truncbf( 3.14, 2 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/c/Makefile new file mode 100644 index 000000000000..62f77d85fb75 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop`): +INCLUDE ?= + +# 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`) +# @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., `-lpthread`) +#/ +$(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/truncbf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/c/example.c new file mode 100644 index 000000000000..c7c9b6ad9b76 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncbf.h" +#include +#include + +int main( void ) { + const float x[] = { 3.14159f, -3.14159f, 15.0f, -15.0f }; + const int32_t n[] = { 2, 3, -1, 0 }; + const int32_t b = 10; + + float y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_truncbf( x[i], n[i], b ); + printf( "truncbf(%f, %d, %d) = %f\n", x[i], n[i], b, y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/index.js new file mode 100644 index 000000000000..0327cf3b4e5c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/examples/index.js @@ -0,0 +1,30 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var randu = require( '@stdlib/random/base/randu' ); +var truncbf = require( './../lib' ); + +var x; +var i; + +for ( i = 0; i < 100; i++ ) { + x = (randu() * 100.0) - 50.0; + console.log( 'truncbf(%d, 2, 10) = %d', x, truncbf( x, 2, 10 ) ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/include.gypi b/lib/node_modules/@stdlib/math/base/special/truncbf/include.gypi new file mode 100644 index 000000000000..ee66fa95b361 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/include.gypi @@ -0,0 +1,62 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gypi` include file which defines variables for building a native add-on. +# +# Main variables: +# +# - `src_dir`: source directory +# - `include_dirs`: list of include directories +# - `src_files`: list of source files +# - `libraries`: list of libraries +# - `library_dirs`: list of library directories +# +# ## Notes +# +# - The `library-manifest` script resolves `dependencies` in `manifest.json` to include directories and libraries. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + '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 single-precision floating-point number toward zero to n digits in base b. +*/ +float stdlib_base_truncbf( const float x, const int32_t n, const int32_t b ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_TRUNCBF_H diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/index.js new file mode 100644 index 000000000000..f2af7cc1e11c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/index.js @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Round a single-precision floating-point number toward zero to `n` digits in base `b`. +* +* @module @stdlib/math/base/special/truncbf +* +* @example +* var truncbf = require( '@stdlib/math/base/special/truncbf' ); +* +* var v = truncbf( 3.14159, 2, 10 ); +* // returns 3.140000104904175 +* +* v = truncbf( 3.14159, 3, 10 ); +* // returns 3.1410000324249268 +* +* v = truncbf( 15.0, -1, 10 ); +* // returns 10.0 +* +* v = truncbf( -3.14159, 2, 10 ); +* // returns -3.140000104904175 +*/ + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var main = require( './main.js' ); + + +// VARIABLES // + +var native = tryRequire( './native.js' ); + + +// MAIN // + +if ( native instanceof Error ) { + native = null; +} +if ( native ) { + setReadOnly( main, 'native', native ); +} + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/main.js new file mode 100644 index 000000000000..6a222526153b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/main.js @@ -0,0 +1,90 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isInfinitef = require( '@stdlib/math/base/assert/is-infinitef' ); +var powf = require( '@stdlib/math/base/special/powf' ); +var truncf = require( '@stdlib/math/base/special/truncf' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + + +// MAIN // + +/** +* Rounds a single-precision floating-point number toward zero to `n` digits in base `b`. +* +* @param {number} x - input value +* @param {integer} n - number of digits +* @param {integer} b - base +* @returns {number} rounded value +* +* @example +* var v = truncbf( 3.14159, 2, 10 ); +* // returns 3.140000104904175 +* +* @example +* var v = truncbf( 3.14159, 3, 10 ); +* // returns 3.1410000324249268 +* +* @example +* var v = truncbf( 15.0, -1, 10 ); +* // returns 10.0 +* +* @example +* var v = truncbf( -3.14159, 2, 10 ); +* // returns -3.140000104904175 +* +* @example +* var v = truncbf( NaN, 2, 10 ); +* // returns NaN +*/ +function truncbf( x, n, b ) { + var s; + var y; + + x = float64ToFloat32( x ); + + if ( x === 0.0 || isnanf( x ) || isInfinitef( x ) ) { + return x; + } + if ( b === 0 ) { + return NaN; + } + + // Compute scale factor in single precision: s = b^n + s = powf( float64ToFloat32( b ), float64ToFloat32( n ) ); + + // Handle overflow in scale factor + if ( isInfinitef( s ) ) { + return x; + } + + // Multiply by scale, truncate, then divide by scale + y = truncf( x * s ) / s; + + return float64ToFloat32( y ); +} + + +// EXPORTS // + +module.exports = truncbf; diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/native.js new file mode 100644 index 000000000000..0cf0ea1ae79c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/lib/native.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds a single-precision floating-point number toward zero to `n` digits in base `b`. +* +* @private +* @param {number} x - input value +* @param {integer} n - number of digits +* @param {integer} b - base +* @returns {number} rounded value +* +* @example +* var v = truncbf( 3.14159, 2, 10 ); +* // returns 3.140000104904175 +*/ +function truncbf( x, n, b ) { + return addon( x, n, b ); +} + + +// EXPORTS // + +module.exports = truncbf; diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/manifest.json b/lib/node_modules/@stdlib/math/base/special/truncbf/manifest.json new file mode 100644 index 000000000000..558f6069e68a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/manifest.json @@ -0,0 +1,85 @@ +{ + "options": { + "task": "build", + "wasm": false + }, + "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", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-infinitef", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/napi/ternary", + "@stdlib/math/base/special/powf", + "@stdlib/math/base/special/truncf" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-infinitef", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/special/powf", + "@stdlib/math/base/special/truncf" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-infinitef", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/special/powf", + "@stdlib/math/base/special/truncf" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/package.json b/lib/node_modules/@stdlib/math/base/special/truncbf/package.json new file mode 100644 index 000000000000..e4064d67c484 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/package.json @@ -0,0 +1,254 @@ +{ + "name": "@stdlib/math/base/special/truncbf", + "version": "0.0.0", + "description": "Round a single-precision floating-point number toward zero to n digits in base b.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": { + "@stdlib/math/base/assert/is-infinitef": "^0.2.2", + "@stdlib/math/base/assert/is-nanf": "^0.2.2", + "@stdlib/math/base/napi/ternary": "^0.2.2", + "@stdlib/math/base/special/powf": "^0.2.2", + "@stdlib/math/base/special/truncf": "^0.2.2", + "@stdlib/number/float64/base/to-float32": "^0.2.2", + "@stdlib/utils/library-manifest": "^0.2.2" + }, + "devDependencies": { + "@stdlib/constants/float32/eps": "^0.2.2", + "@stdlib/constants/float32/ninf": "^0.2.2", + "@stdlib/constants/float32/pinf": "^0.2.2", + "@stdlib/math/base/assert/is-negative-zerof": "^0.2.2", + "@stdlib/math/base/assert/is-positive-zerof": "^0.2.2", + "@stdlib/math/base/special/abs": "^0.2.2", + "istanbul": "^0.4.1", + "tap-min": "git+https://github.com/Planeshifter/tap-min.git", + "tape": "git+https://github.com/kgryte/tape.git#fix/globby" + }, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "special", + "functions", + "function", + "base", + "number", + "float", + "float32", + "single", + "precision", + "floating-point", + "truncate", + "trunc", + "round", + "digits", + "rounding" + ], + "__stdlib__": { + "scaffold": { + "$schema": "math/base@v1.0", + "base_alias": "truncb", + "alias": "truncbf", + "pkg_desc": "round a single-precision floating-point number toward zero to n digits in base b", + "desc": "rounds a single-precision floating-point number toward zero to `n` digits in base `b`", + "short_desc": "round a single-precision floating-point number toward zero to n digits in base b", + "parameters": [ + { + "name": "x", + "desc": "input value", + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + }, + "domain": [ + { + "min": "-infinity", + "max": "infinity" + } + ], + "rand": { + "prng": "random/base/uniform", + "parameters": [ + -100, + 100 + ] + }, + "example_values": [ + 3.14159, + -3.14159, + 15, + -15, + 123.456, + -123.456, + 7.875, + -7.875, + 255.99, + -255.99, + 0.123456, + -0.123456, + 1.23456789, + -1.23456789, + 9.999, + -9.999, + 20, + -20, + 5.6789, + -5.6789 + ] + }, + { + "name": "n", + "desc": "number of digits", + "type": { + "javascript": "integer", + "jsdoc": "integer", + "c": "int32_t", + "dtype": "int32" + }, + "domain": [ + { + "min": "-infinity", + "max": "infinity" + } + ], + "rand": { + "prng": "random/base/discrete-uniform", + "parameters": [ + -5, + 5 + ] + }, + "example_values": [ + 2, + 3, + -1, + 0, + 1, + 4, + -2, + 5, + -3, + 2, + 3, + 1, + 0, + 2, + 1, + 3, + -2, + 2, + 1, + 2 + ] + }, + { + "name": "b", + "desc": "base", + "type": { + "javascript": "integer", + "jsdoc": "integer", + "c": "int32_t", + "dtype": "int32" + }, + "domain": [ + { + "min": "0", + "max": "infinity" + } + ], + "rand": { + "prng": "random/base/discrete-uniform", + "parameters": [ + 2, + 16 + ] + }, + "example_values": [ + 10, + 10, + 10, + 10, + 10, + 10, + 2, + 2, + 16, + 16, + 8, + 8, + 10, + 10, + 10, + 10, + 2, + 10, + 10, + 10 + ] + } + ], + "returns": [ + { + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + } + } + ], + "tests": { + "hermitian": false, + "symmetric": false + } + } + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/truncbf/src/Makefile new file mode 100644 index 000000000000..82d89411ce9f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/src/Makefile @@ -0,0 +1,129 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := main.o + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} SOURCE_FILES - list of C source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +#/ +$(c_targets): %.o: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -c -o $@ $< + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/truncbf/src/addon.c new file mode 100644 index 000000000000..bd9636dc5721 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncbf.h" +#include "stdlib/math/base/napi/ternary/fii_f.h" +#include + +STDLIB_MATH_BASE_NAPI_MODULE_FII_F( stdlib_base_truncbf ) diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/src/main.c b/lib/node_modules/@stdlib/math/base/special/truncbf/src/main.c new file mode 100644 index 000000000000..e373208c6ed6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/src/main.c @@ -0,0 +1,53 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/truncbf.h" +#include "stdlib/math/base/special/powf.h" +#include "stdlib/math/base/special/truncf.h" +#include "stdlib/math/base/assert/is_nanf.h" +#include "stdlib/math/base/assert/is_infinitef.h" +#include + +/** +* Rounds a single-precision floating-point number toward zero to n digits in base b. +* +* @param x input value +* @param n number of digits +* @param b base +* @return output value +* +* @example +* float y = stdlib_base_truncbf( 3.14159f, 2, 10 ); +* // returns 3.14f +*/ +float stdlib_base_truncbf( const float x, const int32_t n, const int32_t b ) { + float s; + + if ( stdlib_base_is_nanf( x ) || stdlib_base_is_infinitef( x ) || x == 0.0f ) { + return x; + } + if ( b == 0 ) { + return 0.0f / 0.0f; + } + s = stdlib_base_powf( (float)b, (float)n ); + if ( stdlib_base_is_infinitef( s ) ) { + return x; + } + return stdlib_base_truncf( x * s ) / s; +} + diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.js b/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.js new file mode 100644 index 000000000000..ed8659178537 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.js @@ -0,0 +1,162 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +// eslint-disable-next-line node/no-unpublished-require +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var isNegativeZerof = require( '@stdlib/math/base/assert/is-negative-zerof' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var NINF = require( '@stdlib/constants/float32/ninf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var truncbf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof truncbf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds a number toward zero to n digits in base 10', function test( t ) { + var delta; + var tol; + var v; + + v = truncbf( 3.14159, 0, 10 ); + t.strictEqual( v, 3.0, 'equals expected value' ); + + v = truncbf( 3.14159, 1, 10 ); + delta = abs( v - 3.1 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 3.14159, 2, 10 ); + delta = abs( v - 3.14 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 3.14159, 3, 10 ); + delta = abs( v - 3.141 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 15.0, -1, 10 ); + t.strictEqual( v, 10.0, 'equals expected value' ); + + v = truncbf( 158.0, -2, 10 ); + t.strictEqual( v, 100.0, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function rounds negative numbers toward zero to n digits in base 10', function test( t ) { + var delta; + var tol; + var v; + + v = truncbf( -3.14159, 0, 10 ); + t.strictEqual( v, -3.0, 'equals expected value' ); + + v = truncbf( -3.14159, 1, 10 ); + delta = abs( v - (-3.1) ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( -3.14159, 2, 10 ); + delta = abs( v - (-3.14) ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( -15.0, -1, 10 ); + t.strictEqual( v, -10.0, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function rounds a number toward zero to n digits in base 2', function test( t ) { + var v; + + v = truncbf( 5.5, 0, 2 ); + t.strictEqual( v, 5.0, 'equals expected value' ); + + v = truncbf( 7.5, 0, 2 ); + t.strictEqual( v, 7.0, 'equals expected value' ); + + v = truncbf( 7.75, 1, 2 ); + t.strictEqual( v, 7.5, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function returns NaN if provided NaN', function test( t ) { + var v = truncbf( NaN, 2, 10 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns NaN if provided a base of 0', function test( t ) { + var v = truncbf( 3.14, 2, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns +0 if provided +0', function test( t ) { + var v = truncbf( 0.0, 2, 10 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns -0 if provided -0', function test( t ) { + var v = truncbf( -0.0, 2, 10 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns +infinity if provided +infinity', function test( t ) { + var v = truncbf( PINF, 2, 10 ); + t.strictEqual( v, PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns -infinity if provided -infinity', function test( t ) { + var v = truncbf( NINF, 2, 10 ); + t.strictEqual( v, NINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function handles scale factor overflow gracefully', function test( t ) { + var v; + + // When b^n overflows to Infinity, should return x unchanged + v = truncbf( 3.14, 40, 10 ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'handles large exponent' ); + + v = truncbf( -2.5, 50, 10 ); + t.strictEqual( v, float64ToFloat32( -2.5 ), 'handles large exponent with negative x' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.native.js new file mode 100644 index 000000000000..1b95d65636ed --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/truncbf/test/test.native.js @@ -0,0 +1,171 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; + +// eslint-disable-next-line node/no-unpublished-require +var tape = require( 'tape' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var isNegativeZerof = require( '@stdlib/math/base/assert/is-negative-zerof' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var NINF = require( '@stdlib/constants/float32/ninf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); + + +// VARIABLES // + +var truncbf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( truncbf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof truncbf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds a number toward zero to n digits in base 10', opts, function test( t ) { + var delta; + var tol; + var v; + + v = truncbf( 3.14159, 0, 10 ); + t.strictEqual( v, 3.0, 'equals expected value' ); + + v = truncbf( 3.14159, 1, 10 ); + delta = abs( v - 3.1 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 3.14159, 2, 10 ); + delta = abs( v - 3.14 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 3.14159, 3, 10 ); + delta = abs( v - 3.141 ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( 15.0, -1, 10 ); + t.strictEqual( v, 10.0, 'equals expected value' ); + + v = truncbf( 158.0, -2, 10 ); + t.strictEqual( v, 100.0, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function rounds negative numbers toward zero to n digits in base 10', opts, function test( t ) { + var delta; + var tol; + var v; + + v = truncbf( -3.14159, 0, 10 ); + t.strictEqual( v, -3.0, 'equals expected value' ); + + v = truncbf( -3.14159, 1, 10 ); + delta = abs( v - (-3.1) ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( -3.14159, 2, 10 ); + delta = abs( v - (-3.14) ); + tol = EPS; + t.ok( delta <= tol, 'equals expected value' ); + + v = truncbf( -15.0, -1, 10 ); + t.strictEqual( v, -10.0, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function rounds a number toward zero to n digits in base 2', opts, function test( t ) { + var v; + + v = truncbf( 5.5, 0, 2 ); + t.strictEqual( v, 5.0, 'equals expected value' ); + + v = truncbf( 7.5, 0, 2 ); + t.strictEqual( v, 7.0, 'equals expected value' ); + + v = truncbf( 7.75, 1, 2 ); + t.strictEqual( v, 7.5, 'equals expected value' ); + + t.end(); +}); + +tape( 'the function returns NaN if provided NaN', opts, function test( t ) { + var v = truncbf( NaN, 2, 10 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns NaN if provided a base of 0', opts, function test( t ) { + var v = truncbf( 3.14, 2, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns +0 if provided +0', opts, function test( t ) { + var v = truncbf( 0.0, 2, 10 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns -0 if provided -0', opts, function test( t ) { + var v = truncbf( -0.0, 2, 10 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns +infinity if provided +infinity', opts, function test( t ) { + var v = truncbf( PINF, 2, 10 ); + t.strictEqual( v, PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns -infinity if provided -infinity', opts, function test( t ) { + var v = truncbf( NINF, 2, 10 ); + t.strictEqual( v, NINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function handles scale factor overflow gracefully', opts, function test( t ) { + var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + var v; + + // When b^n overflows to Infinity, should return x unchanged + v = truncbf( 3.14, 40, 10 ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'handles large exponent' ); + + v = truncbf( -2.5, 50, 10 ); + t.strictEqual( v, float64ToFloat32( -2.5 ), 'handles large exponent with negative x' ); + + t.end(); +});