From cc37b2bfa34213fe9f93d7fb45d582fbc9f838ac Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Mon, 23 Jun 2025 18:09:57 -0700 Subject: [PATCH 1/2] feat: add `math/base/special/round-nearest-even` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../base/special/round-nearest-even/README.md | 214 ++++++++++++++++++ .../round-nearest-even/benchmark/benchmark.js | 52 +++++ .../benchmark/benchmark.native.js | 61 +++++ .../benchmark/c/native/Makefile | 146 ++++++++++++ .../benchmark/c/native/benchmark.c | 138 +++++++++++ .../special/round-nearest-even/binding.gyp | 170 ++++++++++++++ .../special/round-nearest-even/docs/repl.txt | 43 ++++ .../round-nearest-even/docs/types/index.d.ts | 84 +++++++ .../round-nearest-even/docs/types/test.ts | 44 ++++ .../round-nearest-even/examples/c/Makefile | 146 ++++++++++++ .../round-nearest-even/examples/c/example.c | 31 +++ .../round-nearest-even/examples/index.js | 30 +++ .../special/round-nearest-even/include.gypi | 53 +++++ .../math/base/special/round_nearest_even.h | 38 ++++ .../special/round-nearest-even/lib/index.js | 76 +++++++ .../special/round-nearest-even/lib/main.js | 110 +++++++++ .../special/round-nearest-even/lib/native.js | 94 ++++++++ .../special/round-nearest-even/manifest.json | 85 +++++++ .../special/round-nearest-even/package.json | 67 ++++++ .../special/round-nearest-even/src/Makefile | 70 ++++++ .../special/round-nearest-even/src/addon.c | 22 ++ .../special/round-nearest-even/src/main.c | 53 +++++ .../special/round-nearest-even/test/test.js | 126 +++++++++++ .../round-nearest-even/test/test.native.js | 135 +++++++++++ 24 files changed, 2088 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/include/stdlib/math/base/special/round_nearest_even.h create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/main.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/package.json create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md new file mode 100644 index 000000000000..8f614630c942 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md @@ -0,0 +1,214 @@ + + +# Round + +> Round a numeric value to the nearest integer with ties rounding to the nearest even integer. + +
+ +## Usage + +```javascript +var roundNearestEven = require( '@stdlib/math/base/special/round-nearest-even' ); +``` + +#### roundNearestEven( x ) + +Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer. + +```javascript +var v = roundNearestEven( -3.5 ); +// returns -4.0 + +v = roundNearestEven( -4.2 ); +// returns -4.0 + +v = roundNearestEven( -4.5 ); +// returns -4.0 + +v = roundNearestEven( -4.6 ); +// returns -5.0 + +v = roundNearestEven( 9.99999 ); +// returns 10.0 + +v = roundNearestEven( 8.5 ); +// returns 8.0 + +v = roundNearestEven( 9.5 ); +// returns 10.0 + +v = roundNearestEven( 9.2 ); +// returns 9.0 + +v = roundNearestEven( 0.0 ); +// returns 0.0 + +v = roundNearestEven( -0.0 ); +// returns -0.0 + +v = roundNearestEven( Infinity ); +// returns Infinity + +v = roundNearestEven( -Infinity ); +// returns -Infinity + +v = roundNearestEven( NaN ); +// returns NaN +``` + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var roundNearestEven = require( '@stdlib/math/base/special/round-nearest-even' ); + +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -50.0, 50.0, opts ); + +logEachMap( 'roundNearestEven(%.4f) = %.4f', x, roundNearestEven ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/round_nearest_even.h" +``` + +#### stdlib_base_round_nearest_even( x ) + +Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer. + +```c +double out = stdlib_base_round_nearest_even( -4.5 ); +// returns -4.0 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_round_nearest_even( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/round_nearest_even.h" +#include + +int main( void ) { + const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.50, 0.50, 1.67, 2.78, 3.89, 5.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_round_nearest_even( x[ i ] ); + printf( "roundNearestEven(%lf) = %lf\n", x[ i ], v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ + + + + +
+ + diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.js new file mode 100644 index 000000000000..24016c50821d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.js @@ -0,0 +1,52 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var roundNearestEven = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = roundNearestEven( x[ i%x.length ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.native.js new file mode 100644 index 000000000000..e555ba6c84d8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/benchmark.native.js @@ -0,0 +1,61 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var roundNearestEven = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( roundNearestEven instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = roundNearestEven( x[ i%x.length ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/Makefile new file mode 100644 index 000000000000..5d7e79f50788 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles 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`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lpthread -lblas`) +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [C_COMPILER] - C compiler +# @param {string} [CFLAGS] - C compiler flags +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code +# +# @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|void)} INCLUDE - list of includes (e.g., `-I /foo/bar -I /beep/boop`) +# @param {(string|void)} LIBRARIES - list of libraries (e.g., `-lpthread -lblas`) +# @param {(string|void)} LIBPATH - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} CC - C compiler +# @param {string} CFLAGS - C compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(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/round-nearest-even/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..e826be6b859c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/benchmark/c/native/benchmark.c @@ -0,0 +1,138 @@ +/** +* @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/round_nearest_even.h" +#include +#include +#include +#include +#include + +#define NAME "round-nearest-even" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double x[ 100 ]; + double elapsed; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( -500.0, 500.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_round_nearest_even( x[ i%100 ] ); + 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/round-nearest-even/binding.gyp b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/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/round-nearest-even/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/repl.txt new file mode 100644 index 000000000000..45d40ad763b4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/repl.txt @@ -0,0 +1,43 @@ + +{{alias}}( x ) + Rounds a numeric value to the nearest integer with ties rounding to the + nearest even integer. + + Parameters + ---------- + x: number + Input value. + + Returns + ------- + y: number + Rounded value. + + Examples + -------- + > var y = {{alias}}( -3.5 ) + -4.0 + > y = {{alias}}( -4.2 ) + -4.0 + > y = {{alias}}( -4.5 ) + -4.0 + > y = {{alias}}( 8.5 ) + 8.0 + > y = {{alias}}( 9.2 ) + 9.0 + > y = {{alias}}( 9.5 ) + 10.0 + > y = {{alias}}( -0.0 ) + -0.0 + > y = {{alias}}( 0.0 ) + 0.0 + > y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}} ) + Infinity + > y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}} ) + -Infinity + > y = {{alias}}( NaN ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/index.d.ts new file mode 100644 index 000000000000..611e854b2222 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/index.d.ts @@ -0,0 +1,84 @@ +/* +* @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 numeric value to the nearest integer with ties rounding to the nearest even integer. +* +* @param x - input value +* @returns function value +* +* @example +* var v = roundNearestEven( -3.5 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.2 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.5 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.6 ); +* // returns -5.0 +* +* @example +* var v = roundNearestEven( 9.99999 ); +* // returns 10.0 +* +* @example +* var v = roundNearestEven( 8.5 ); +* // returns 8.0 +* +* @example +* var v = roundNearestEven( 9.5 ); +* // returns 10.0 +* +* @example +* var v = roundNearestEven( 9.2 ); +* // returns 9.0 +* +* @example +* var v = roundNearestEven( 0.0 ); +* // returns 0.0 +* +* @example +* var v = roundNearestEven( -0.0 ); +* // returns -0.0 +* +* @example +* var v = roundNearestEven( Infinity ); +* // returns Infinity +* +* @example +* var v = roundNearestEven( -Infinity ); +* // returns -Infinity +* +* @example +* var v = roundNearestEven( NaN ); +* // returns NaN +*/ +declare function roundNearestEven( x: number ): number; + + +// EXPORTS // + +export = roundNearestEven; diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/test.ts new file mode 100644 index 000000000000..8690fafe9529 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/test.ts @@ -0,0 +1,44 @@ +/* +* @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 roundNearestEven = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + roundNearestEven( 2.86 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + roundNearestEven( true ); // $ExpectError + roundNearestEven( false ); // $ExpectError + roundNearestEven( null ); // $ExpectError + roundNearestEven( undefined ); // $ExpectError + roundNearestEven( '5' ); // $ExpectError + roundNearestEven( [] ); // $ExpectError + roundNearestEven( {} ); // $ExpectError + roundNearestEven( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + roundNearestEven(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/example.c new file mode 100644 index 000000000000..56e0cba6f2b3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/round_nearest_even.h" +#include + +int main( void ) { + const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.50, 0.50, 1.67, 2.78, 3.89, 5.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_round_nearest_even( x[ i ] ); + printf( "roundNearestEven(%lf) = %lf\n", x[ i ], v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/index.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/examples/index.js new file mode 100644 index 000000000000..1dd31d781d9a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/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 uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var roundNearestEven = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -50.0, 50.0, opts ); + +logEachMap( 'roundNearestEven(%.4f) = %.4f', x, roundNearestEven ); diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/include.gypi b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' 0.5 ) { // Round up + return int + 1.0; + } + if ( frac < 0.5 ) { // Round down + return int; + } + // Tie case where we round to the nearest even integer: + return ( int % 2 === 0 ) ? int : int + 1.0; +} + + +// EXPORTS // + +module.exports = roundNearestEven; diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/native.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/native.js new file mode 100644 index 000000000000..0eb1da3a8793 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/native.js @@ -0,0 +1,94 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer. +* +* @private +* @param {number} x - input value +* @returns {number} function value +* +* @example +* var v = roundNearestEven( -3.5 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.2 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.5 ); +* // returns -4.0 +* +* @example +* var v = roundNearestEven( -4.6 ); +* // returns -5.0 +* +* @example +* var v = roundNearestEven( 9.99999 ); +* // returns 10.0 +* +* @example +* var v = roundNearestEven( 8.5 ); +* // returns 8.0 +* +* @example +* var v = roundNearestEven( 9.5 ); +* // returns 10.0 +* +* @example +* var v = roundNearestEven( 9.2 ); +* // returns 9.0 +* +* @example +* var v = roundNearestEven( 0.0 ); +* // returns 0.0 +* +* @example +* var v = roundNearestEven( -0.0 ); +* // returns -0.0 +* +* @example +* var v = roundNearestEven( Infinity ); +* // returns Infinity +* +* @example +* var v = roundNearestEven( -Infinity ); +* // returns -Infinity +* +* @example +* var v = roundNearestEven( NaN ); +* // returns NaN +*/ +function roundNearestEven( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = roundNearestEven; diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/manifest.json b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/manifest.json new file mode 100644 index 000000000000..0c01065a0dab --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/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/napi/unary", + "@stdlib/math/base/special/floor", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-even", + "@stdlib/math/base/assert/is-infinite" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floor", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-even", + "@stdlib/math/base/assert/is-infinite" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floor", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-even", + "@stdlib/math/base/assert/is-infinite" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/package.json b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/package.json new file mode 100644 index 000000000000..37674c3ee001 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/package.json @@ -0,0 +1,67 @@ +{ + "name": "@stdlib/math/base/special/round-nearest-even", + "version": "0.0.0", + "description": "Round a numeric value to the nearest integer with ties rounding to the nearest even integer.", + "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": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "math.round", + "round", + "round-nearest-even", + "round-nearest", + "integer", + "nearest", + "number" + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/Makefile b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/addon.c b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/addon.c new file mode 100644 index 000000000000..cb2deba2c2a8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/addon.c @@ -0,0 +1,22 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/round_nearest_even.h" +#include "stdlib/math/base/napi/unary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_round_nearest_even ) diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/main.c b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/main.c new file mode 100644 index 000000000000..b0fbcb0a0aed --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/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/round_nearest_even.h" +#include "stdlib/math/base/special/floor.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/assert/is_even.h" +#include "stdlib/math/base/assert/is_infinite.h" +#include + +/** +* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer. +* +* @param x input value +* @return output value +* +* @example +* double out = stdlib_base_round_nearest_even( -4.2 ); +* // returns -4.0 +*/ +double stdlib_base_round_nearest_even( const double x ) { + double integer; + double frac; + + if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) || x == 0.0 ) { + return x; + } + integer = stdlib_base_floor( x ); + frac = x - integer; + if ( frac > 0.5 ) { // Round up + return integer + 1.0; + } + if ( frac < 0.5 ) { // Round down + return integer; + } + // Tie case where we round to the nearest even integer: + return stdlib_base_is_even( integer ) ? integer : integer + 1.0; +} diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.js new file mode 100644 index 000000000000..ff65186e401f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.js @@ -0,0 +1,126 @@ +/** +* @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 tape = require( 'tape' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var roundNearestEven = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof roundNearestEven, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds a numeric value to the nearest integer', function test( t ) { + t.strictEqual( roundNearestEven( -4.2 ), -4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( -4.5 ), -4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( -4.8 ), -5.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 4.2 ), 4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 4.5 ), 4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.99999 ), 10.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.5 ), 10.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.4 ), 9.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 0.0 ), 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', function test( t ) { + var v = roundNearestEven( -0.0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', function test( t ) { + var v = roundNearestEven( NaN ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided a `+infinity`', function test( t ) { + var v = roundNearestEven( PINF ); + t.strictEqual( v, PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided a `-infinity`', function test( t ) { + var v = roundNearestEven( NINF ); + t.strictEqual( v, NINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the correct result for large positive non-decimal values', function test( t ) { + var start = 4503599627370496; + var end = 4503599627375000; + var i; + + for ( i = start; i < end; i++ ) { + t.strictEqual( roundNearestEven( i ), i, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns the correct result for large negative non-decimal values', function test( t ) { + var start = -4503599627375000; + var end = -4503599627370496; + var i; + + for ( i = start; i < end; i++ ) { + t.strictEqual( roundNearestEven( i ), i, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function rounds to the nearest even integer for positive decimal values', function test( t ) { + var start = 0.0; + var end = 100.0; + var i; + + for ( i = start; i < end; i++ ) { + if ( i % 2 === 0 ) { + t.strictEqual( roundNearestEven( i + 0.5 ), i, 'returns expected value' ); + } else { + t.strictEqual( roundNearestEven( i + 0.5 ), i + 1, 'returns expected value' ); + } + } + t.end(); +}); + +tape( 'the function rounds to the nearest even integer for negative decimal values', function test( t ) { + var start = -100.0; + var end = 0.0; + var i; + + for ( i = start; i < end; i++ ) { + if ( i % 2 === 0 ) { + t.strictEqual( roundNearestEven( i - 0.5 ), i, 'returns expected value' ); + } else { + t.strictEqual( roundNearestEven( i - 0.5 ), i - 1, 'returns expected value' ); + } + } + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.native.js new file mode 100644 index 000000000000..e1e6f94b44c2 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/test/test.native.js @@ -0,0 +1,135 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var roundNearestEven = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( roundNearestEven instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof roundNearestEven, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds a numeric value to the nearest integer', opts, function test( t ) { + t.strictEqual( roundNearestEven( -4.2 ), -4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( -4.5 ), -4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( -4.8 ), -5.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 4.2 ), 4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 4.5 ), 4.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.99999 ), 10.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.5 ), 10.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 9.4 ), 9.0, 'returns expected value' ); + t.strictEqual( roundNearestEven( 0.0 ), 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v = roundNearestEven( -0.0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', opts, function test( t ) { + var v = roundNearestEven( NaN ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided a `+infinity`', opts, function test( t ) { + var v = roundNearestEven( PINF ); + t.strictEqual( v, PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided a `-infinity`', opts, function test( t ) { + var v = roundNearestEven( NINF ); + t.strictEqual( v, NINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns the correct result for large positive non-decimal values', opts, function test( t ) { + var start = 4503599627370496; + var end = 4503599627375000; + var i; + + for ( i = start; i < end; i++ ) { + t.strictEqual( roundNearestEven( i ), i, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns the correct result for large negative non-decimal values', opts, function test( t ) { + var start = -4503599627375000; + var end = -4503599627370496; + var i; + + for ( i = start; i < end; i++ ) { + t.strictEqual( roundNearestEven( i ), i, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function rounds to the nearest even integer for positive decimal values', opts, function test( t ) { + var start = 0.0; + var end = 100.0; + var i; + + for ( i = start; i < end; i++ ) { + if ( i % 2 === 0 ) { + t.strictEqual( roundNearestEven( i + 0.5 ), i, 'returns expected value' ); + } else { + t.strictEqual( roundNearestEven( i + 0.5 ), i + 1, 'returns expected value' ); + } + } + t.end(); +}); + +tape( 'the function rounds to the nearest even integer for negative decimal values', opts, function test( t ) { + var start = -100.0; + var end = 0.0; + var i; + + for ( i = start; i < end; i++ ) { + if ( i % 2 === 0 ) { + t.strictEqual( roundNearestEven( i - 0.5 ), i, 'returns expected value' ); + } else { + t.strictEqual( roundNearestEven( i - 0.5 ), i - 1, 'returns expected value' ); + } + } + t.end(); +}); From 8b10eb4ecfc40b8e823b95ddb495be00bdef55ff Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 25 Jun 2025 21:45:21 -0700 Subject: [PATCH 2/2] docs: update heading Signed-off-by: Athan --- .../@stdlib/math/base/special/round-nearest-even/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md index 8f614630c942..c62c905de543 100644 --- a/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md +++ b/lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md @@ -18,7 +18,7 @@ limitations under the License. --> -# Round +# roundNearestEven > Round a numeric value to the nearest integer with ties rounding to the nearest even integer.