From 594602fa7a313847e6b3a6f64fdea3be2f2f01f6 Mon Sep 17 00:00:00 2001 From: nakul-krishnakumar Date: Fri, 19 Sep 2025 19:16:34 +0530 Subject: [PATCH 01/13] feat: add `math/base/special/fast/maxf` --- 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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 --- --- .../math/base/special/fast/maxf/README.md | 234 ++++++++++++++++++ .../special/fast/maxf/benchmark/benchmark.js | 59 +++++ .../fast/maxf/benchmark/benchmark.native.js | 67 +++++ .../fast/maxf/benchmark/c/native/Makefile | 146 +++++++++++ .../fast/maxf/benchmark/c/native/benchmark.c | 138 +++++++++++ .../math/base/special/fast/maxf/binding.gyp | 170 +++++++++++++ .../math/base/special/fast/maxf/docs/repl.txt | 35 +++ .../special/fast/maxf/docs/types/index.d.ts | 58 +++++ .../base/special/fast/maxf/docs/types/test.ts | 51 ++++ .../special/fast/maxf/examples/c/Makefile | 146 +++++++++++ .../special/fast/maxf/examples/c/example.c | 35 +++ .../base/special/fast/maxf/examples/index.js | 34 +++ .../math/base/special/fast/maxf/include.gypi | 53 ++++ .../stdlib/math/base/special/fast/maxf.h | 38 +++ .../math/base/special/fast/maxf/lib/index.js | 52 ++++ .../math/base/special/fast/maxf/lib/main.js | 67 +++++ .../math/base/special/fast/maxf/lib/native.js | 63 +++++ .../math/base/special/fast/maxf/manifest.json | 67 +++++ .../math/base/special/fast/maxf/package.json | 65 +++++ .../math/base/special/fast/maxf/src/Makefile | 70 ++++++ .../math/base/special/fast/maxf/src/addon.c | 22 ++ .../math/base/special/fast/maxf/src/main.c | 45 ++++ .../math/base/special/fast/maxf/test/test.js | 97 ++++++++ .../special/fast/maxf/test/test.native.js | 106 ++++++++ 24 files changed, 1918 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/include/stdlib/math/base/special/fast/maxf.h create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/main.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/package.json create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md new file mode 100644 index 000000000000..f8ee7895140e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md @@ -0,0 +1,234 @@ + + +# maxf + +> Return the maximum single-precision floating-point number. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var maxf = require( '@stdlib/math/base/special/fast/maxf' ); +``` + +#### maxf( x, y ) + +Returns the maximum single-precision floating-point number. + +```javascript +var v = maxf( 4.2, 3.14 ); +// returns 4.199999809265137 +``` + +
+ + + + + +
+ +## Notes + +- The implementation **ignores** the sign of `0`. + + ```javascript + var v = maxf( +0.0, -0.0 ); + // returns -0.0 + + v = maxf( -0.0, +0.0 ); + // returns +0.0 + ``` + +- The implementation does **not** check for `NaN` arguments. + + ```javascript + var v = maxf( 3.14, NaN ); + // returns NaN + + v = maxf( NaN, 3.14 ); + // returns 3.140000104904175 + ``` + +
+ + + + + +
+ +## Examples + + + +```javascript +var minstd = require( '@stdlib/random/base/minstd-shuffle' ); +var maxf = require( '@stdlib/math/base/special/fast/maxf' ); + +var x; +var y; +var v; +var i; + +for ( i = 0; i < 100; i++ ) { + x = minstd(); + y = minstd(); + v = maxf( x, y ); + console.log( 'maxf(%d,%d) = %d', x, y, v ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/fast/maxf.h" +``` + +#### stdlib_base_fast_maxf( x, y ) + +Returns the maximum single-precision floating-point number. + +```c +float out = stdlib_base_fast_maxf( 4.2f, 3.14f ); +// returns 4.2f + +out = stdlib_base_fast_maxf( 0.0f, -0.0f ); +// returns 0.0f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. +- **y**: `[in] float` input value. + +```c +float stdlib_base_fast_maxf( const float x, const float y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/fast/maxf.h" +#include +#include + +int main( void ) { + float x; + float y; + float v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f; + y = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f; + v = stdlib_base_fast_maxf( x, y ); + printf( "x: %f, y: %f, maxf(x, y): %f\n", x, y, v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js new file mode 100644 index 000000000000..c8bbc7e44d85 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js @@ -0,0 +1,59 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; +var maxf = require( './../lib' ); + + +// MAIN // + +bench(pkg, function benchmark(b) { + var opts; + var x; + var y; + var z; + var i; + + opts = { + 'dtype': 'float32' + }; + + x = uniform( 100, -100.0, 100.0, opts ); + y = uniform( 100, -100.0, 100.0, opts ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = maxf( x[ i % x.length ], y[ i % y.length ] ); + if ( isnanf( z ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( z ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..ebbe9d68a9ef --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js @@ -0,0 +1,67 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var maxf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( maxf instanceof Error ) +}; + + +// MAIN // + +bench(pkg + '::native', opts, function benchmark(b) { + var opts; + var x; + var y; + var z; + var i; + + opts = { + 'dtype': 'float32' + }; + x = uniform( 100, -100.0, 100.0, opts ); + y = uniform( 100, -100.0, 100.0, opts ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = maxf( x[ i % x.length ], y[ i % y.length ] ); + if ( isnanf( z ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( z ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..c17ca2af3fde --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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/fast/maxf.h" +#include +#include +#include +#include +#include + +#define NAME "maxf" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static 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[ 100 ]; + float y[ 100 ]; + double t; + float z; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = ( 200.0f * rand_float() ) - 100.0f; + y[ i ] = ( 200.0f * rand_float() ) - 100.0f; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + z = stdlib_base_fast_maxf( x[ i % 100 ], y[ i % 100 ] ); + if ( z != z ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( z != z ) { + 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/fast/maxf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/fast/maxf/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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/fast/maxf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt new file mode 100644 index 000000000000..61124e5aad71 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt @@ -0,0 +1,35 @@ + +{{alias}}( x, y ) + Returns the maximum single-precision floating-point number. + + The function ignores the sign of `0` and does not check for `NaN` arguments. + + Parameters + ---------- + x: number + First number. + + y: number + Second number. + + Returns + ------- + out: number + Maximum value. + + Examples + -------- + > var v = {{alias}}( 3.14, 4.2 ) + 4.199999809265137 + > v = {{alias}}( 3.14, NaN ) + NaN + > v = {{alias}}( NaN, 3.14 ) + 3.140000104904175 + > v = {{alias}}( -0.0, +0.0 ) + +0.0 + > v = {{alias}}( +0.0, -0.0 ) + -0.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts new file mode 100644 index 000000000000..c0427080ef67 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts @@ -0,0 +1,58 @@ +/* +* @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 + +/** +* Returns the maximum single-precision floating-point number. +* +* ## Notes +* +* - The function ignores the sign of `0` and does not check for `NaN` arguments. +* +* @param x - first number +* @param y - second number +* @returns maximum value +* +* @example +* var v = maxf( 3.14, 4.2 ); +* // returns 4.199999809265137 +* +* @example +* var v = maxf( 3.14, NaN ); +* // returns NaN +* +* @example +* var v = maxf( NaN, 3.14 ); +* // returns 3.140000104904175 +* +* @example +* var v = maxf( -0.0, +0.0 ); +* // returns +0.0 +* +* @example +* var v = maxf( +0.0, -0.0 ); +* // returns -0.0 +*/ + +declare function maxf( x: number, y: number ): number; + + +// EXPORTS // + +export = maxf; diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/test.ts new file mode 100644 index 000000000000..6ee18ba24eef --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/test.ts @@ -0,0 +1,51 @@ +/* +* @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 maxf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + maxf( 3.0, -0.2 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided values other than two numbers... +{ + maxf( true, 3.0 ); // $ExpectError + maxf( false, 3.0 ); // $ExpectError + maxf( [], 3.0 ); // $ExpectError + maxf( {}, 3.0 ); // $ExpectError + maxf( 'abc', 3.0 ); // $ExpectError + maxf( ( x: number ): number => x, 3.0 ); // $ExpectError + + maxf( 2.0, true ); // $ExpectError + maxf( 2.0, false ); // $ExpectError + maxf( 2.0, [] ); // $ExpectError + maxf( 2.0, {} ); // $ExpectError + maxf( 2.0, 'abc' ); // $ExpectError + maxf( 2.0, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if provided an unsupported number of arguments... +{ + maxf(); // $ExpectError + maxf( 1.0 ); // $ExpectError + maxf( 1.0, 2.0, 3.0 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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/fast/maxf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/example.c new file mode 100644 index 000000000000..9b1e3b8f0acd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/c/example.c @@ -0,0 +1,35 @@ +/** +* @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/fast/maxf.h" +#include +#include + +int main( void ) { + float x; + float y; + float v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f; + y = ( ( (float)rand() / (float)RAND_MAX ) * 200.0f ) - 100.0f; + v = stdlib_base_fast_maxf( x, y ); + printf( "x: %f, y: %f, maxf(x, y): %f\n", x, y, v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js new file mode 100644 index 000000000000..de9a0c73b401 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js @@ -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. +*/ + +'use strict'; + +var minstd = require( '@stdlib/random/base/minstd-shuffle' ); +var maxf = require( './../lib' ); + +var x; +var y; +var v; +var i; + +for ( i = 0; i < 100; i++ ) { + x = minstd(); + y = minstd(); + v = maxf( x, y ); + console.log( 'maxf(%d,%d) = %d', x, y, v ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/include.gypi b/lib/node_modules/@stdlib/math/base/special/fast/maxf/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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': [ + ' y ) { + return x; + } + return y; +} + + +// EXPORTS // + +module.exports = maxf; diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js new file mode 100644 index 000000000000..5cad0a35490b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js @@ -0,0 +1,63 @@ +/** +* @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 // + +/** +* Returns the maximum single-precision floating-point number. +* +* @private +* @param {number} x - first number +* @param {number} y - second number +* @returns {number} maximum value +* +* @example +* var v = maxf( 3.14, 4.2 ); +* // returns 4.199999809265137 +* +* @example +* var v = maxf( 3.14, NaN ); +* // returns NaN +* +* @example +* var v = maxf( NaN, 3.14 ); +* // returns 3.140000104904175 +* +* @example +* var v = maxf( -0.0, +0.0 ); +* // returns +0.0 +* +* @example +* var v = maxf( +0.0, -0.0 ); +* // returns -0.0 +*/ +function maxf( x, y ) { + return addon( x, y ); +} + + +// EXPORTS // + +module.exports = maxf; diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/manifest.json b/lib/node_modules/@stdlib/math/base/special/fast/maxf/manifest.json new file mode 100644 index 000000000000..2ba181fb7a4b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/manifest.json @@ -0,0 +1,67 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/binary" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/package.json b/lib/node_modules/@stdlib/math/base/special/fast/maxf/package.json new file mode 100644 index 000000000000..db55e5d2da66 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/math/base/special/fast/maxf", + "version": "0.0.0", + "description": "Return the maximum single-precision floating-point number.", + "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.max", + "maximum", + "max", + "largest", + "greatest" + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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/fast/maxf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/addon.c new file mode 100644 index 000000000000..3310e460d13f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/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/fast/maxf.h" +#include "stdlib/math/base/napi/binary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_fast_maxf ) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c new file mode 100644 index 000000000000..04d9ec81d0ba --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c @@ -0,0 +1,45 @@ +/** +* @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/fast/maxf.h" + +/** +* Returns the maximum single-precision floating-point number. +* +* @param x first number +* @param y second number +* @return maximum value +* +* @example +* float v = stdlib_base_fast_maxf( 3.14f, 4.2f ); +* // returns 4.200000 +* +* @example +* float v = stdlib_base_fast_maxf( -0.0f, +0.0f ); +* // returns +0.000000 +* +* @example +* float v = stdlib_base_fast_maxf( +0.0f, -0.0f ); +* // returns -0.000000 +*/ +float stdlib_base_fast_maxf( const float x, const float y ) { + if ( x > y ) { + return x; + } + return y; +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.js new file mode 100644 index 000000000000..384d2484c4c6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.js @@ -0,0 +1,97 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isNegativeZerof = require( '@stdlib/math/base/assert/is-negative-zerof' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var maxf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof maxf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 2', function test( t ) { + t.strictEqual( maxf.length, 2, 'accepts two arguments' ); + t.end(); +}); + +tape( 'the function may not return `NaN` if provided a `NaN`', function test( t ) { + var v; + + v = maxf( NaN, 3.14 ); + t.strictEqual( f32( v ), f32( 3.14 ), 'returns expected value' ); + + v = maxf( 3.14, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { + var v; + + v = maxf( PINF, 3.14 ); + t.strictEqual( f32( v ), PINF, 'returns expected value' ); + + v = maxf( 3.14, PINF ); + t.strictEqual( f32( v ), PINF, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function may not return a correctly signed zero', function test( t ) { + var v; + + v = maxf( +0.0, -0.0 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + + v = maxf( -0.0, +0.0 ); + t.strictEqual( isNegativeZerof( v ), false, 'returns expected value' ); + + v = maxf( -0.0, -0.0 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + + v = maxf( +0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the maximum value', function test( t ) { + var v; + + v = maxf( f32( 4.2 ), f32( 3.14 ) ); + t.strictEqual( f32( v ), f32( 4.2 ), 'returns expected value' ); + + v = maxf( f32( -4.2 ), f32( 3.14 ) ); + t.strictEqual( f32( v ), f32( 3.14 ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.native.js new file mode 100644 index 000000000000..aba25b65e377 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/test/test.native.js @@ -0,0 +1,106 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isNegativeZerof = require( '@stdlib/math/base/assert/is-negative-zerof' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var maxf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( maxf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof maxf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 2', opts, function test( t ) { + t.strictEqual( maxf.length, 2, 'accepts two arguments' ); + t.end(); +}); + +tape( 'the function may not return `NaN` if provided a `NaN`', opts, function test( t ) { + var v; + + v = maxf( NaN, 3.14 ); + t.strictEqual( f32( v ), f32( 3.14 ), 'returns expected value' ); + + v = maxf( 3.14, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `+Infinity` if provided `+Infinity`', opts, function test( t ) { + var v; + + v = maxf( PINF, 3.14 ); + t.strictEqual( v, PINF, 'returns expected value' ); + + v = maxf( 3.14, PINF ); + t.strictEqual( v, PINF, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function may not return a correctly signed zero', opts, function test( t ) { + var v; + + v = maxf( +0.0, -0.0 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + + v = maxf( -0.0, +0.0 ); + t.strictEqual( isNegativeZerof( v ), false, 'returns expected value' ); + + v = maxf( -0.0, -0.0 ); + t.strictEqual( isNegativeZerof( v ), true, 'returns expected value' ); + + v = maxf( +0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the maximum value', opts, function test( t ) { + var v; + + v = maxf( f32( 4.2 ), f32( 3.14 ) ); + t.strictEqual( v, f32( 4.2 ), 'returns expected value' ); + + v = maxf( f32( -4.2 ), f32( 3.14 ) ); + t.strictEqual( v, f32( 3.14 ), 'returns expected value' ); + + t.end(); +}); From 2ecaa8fac76db609792c845e66b51059e3708122 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:04:44 -0700 Subject: [PATCH 02/13] docs: update return annotation Signed-off-by: Athan --- lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md index f8ee7895140e..e79eaa8562fe 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md @@ -46,7 +46,7 @@ Returns the maximum single-precision floating-point number. ```javascript var v = maxf( 4.2, 3.14 ); -// returns 4.199999809265137 +// returns ~4.2 ``` From f0a65923d78644b595d522ef08a55c0cf6f05997 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:05:09 -0700 Subject: [PATCH 03/13] docs: update return annotation Signed-off-by: Athan --- lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md index e79eaa8562fe..d386f3647f43 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md @@ -76,7 +76,7 @@ var v = maxf( 4.2, 3.14 ); // returns NaN v = maxf( NaN, 3.14 ); - // returns 3.140000104904175 + // returns ~3.14 ``` From 0ae08e38d29de450cf36228264352744dba80f86 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:05:56 -0700 Subject: [PATCH 04/13] style: fix spacing Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js index c8bbc7e44d85..2f0942655aa8 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.js @@ -29,7 +29,7 @@ var maxf = require( './../lib' ); // MAIN // -bench(pkg, function benchmark(b) { +bench( pkg, function benchmark( b ) { var opts; var x; var y; From a969c264d072124155ca8d45e75b2a4962935e47 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:06:33 -0700 Subject: [PATCH 05/13] style: fix spacing Signed-off-by: Athan --- .../math/base/special/fast/maxf/benchmark/benchmark.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js index ebbe9d68a9ef..76c5bda265ac 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/benchmark/benchmark.native.js @@ -38,7 +38,7 @@ var opts = { // MAIN // -bench(pkg + '::native', opts, function benchmark(b) { +bench( pkg + '::native', opts, function benchmark( b ) { var opts; var x; var y; From b252bbd75750de838d8bf96853932b500eaa762a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:08:21 -0700 Subject: [PATCH 06/13] docs: update return annotations Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt index 61124e5aad71..fdc43370d918 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/repl.txt @@ -20,11 +20,11 @@ Examples -------- > var v = {{alias}}( 3.14, 4.2 ) - 4.199999809265137 + ~4.2 > v = {{alias}}( 3.14, NaN ) NaN > v = {{alias}}( NaN, 3.14 ) - 3.140000104904175 + ~3.14 > v = {{alias}}( -0.0, +0.0 ) +0.0 > v = {{alias}}( +0.0, -0.0 ) From c9a66c7f333e5552b729692cba14f905239ab25a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:09:15 -0700 Subject: [PATCH 07/13] docs: use approximate rather than exact values Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts index c0427080ef67..64b7329c1b01 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts @@ -31,7 +31,7 @@ * * @example * var v = maxf( 3.14, 4.2 ); -* // returns 4.199999809265137 +* // returns ~4.2 * * @example * var v = maxf( 3.14, NaN ); @@ -39,7 +39,7 @@ * * @example * var v = maxf( NaN, 3.14 ); -* // returns 3.140000104904175 +* // returns ~3.14 * * @example * var v = maxf( -0.0, +0.0 ); From bddb5352d5b3c99aeebda396ba21fc24f0d3019c Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:10:31 -0700 Subject: [PATCH 08/13] docs: update return annotations Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/lib/index.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/index.js index 89eda77afba5..99ed3c563952 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/index.js @@ -27,13 +27,13 @@ * var maxf = require( '@stdlib/math/base/special/fast/maxf' ); * * var v = maxf( 3.14, 4.2 ); -* // returns 4.199999809265137 +* // returns ~4.2 * * var v = maxf( 3.14, NaN ); * // returns NaN * * var v = maxf( NaN, 3.14 ); -* // returns 3.140000104904175 +* // returns ~3.14 * * var v = maxf( -0.0, +0.0 ); * // returns +0.0 From 2a2b10b07b61d57834f6f45b57981084c7b9c2ff Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:11:30 -0700 Subject: [PATCH 09/13] docs: update return annotations Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/src/main.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c index 04d9ec81d0ba..f61a146a2fb9 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/src/main.c @@ -27,15 +27,15 @@ * * @example * float v = stdlib_base_fast_maxf( 3.14f, 4.2f ); -* // returns 4.200000 +* // returns 4.2f * * @example * float v = stdlib_base_fast_maxf( -0.0f, +0.0f ); -* // returns +0.000000 +* // returns +0.0f * * @example * float v = stdlib_base_fast_maxf( +0.0f, -0.0f ); -* // returns -0.000000 +* // returns -0.0f */ float stdlib_base_fast_maxf( const float x, const float y ) { if ( x > y ) { From fa2233ef7a52ed797a96f96083bf4ce7a8d4ca7a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:13:16 -0700 Subject: [PATCH 10/13] docs: update return annotations Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/lib/main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/main.js index 3064c03eb4bb..9a2e2474c4cf 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/main.js @@ -34,7 +34,7 @@ var f32 = require( '@stdlib/number/float64/base/to-float32' ); * * @example * var v = maxf( 3.14, 4.2 ); -* // returns 4.199999809265137 +* // returns ~4.2 * * @example * var v = maxf( 3.14, NaN ); @@ -42,7 +42,7 @@ var f32 = require( '@stdlib/number/float64/base/to-float32' ); * * @example * var v = maxf( NaN, 3.14 ); -* // returns 3.140000104904175 +* // returns ~3.14 * * @example * var v = maxf( -0.0, +0.0 ); From 00b3c5f0ebf303c2b1b3ffa7cbdd250c50c7188a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:14:01 -0700 Subject: [PATCH 11/13] docs: update return annotations Signed-off-by: Athan --- .../@stdlib/math/base/special/fast/maxf/lib/native.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js index 5cad0a35490b..409ea1be35c0 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/lib/native.js @@ -35,7 +35,7 @@ var addon = require( './../src/addon.node' ); * * @example * var v = maxf( 3.14, 4.2 ); -* // returns 4.199999809265137 +* // returns ~4.2 * * @example * var v = maxf( 3.14, NaN ); @@ -43,7 +43,7 @@ var addon = require( './../src/addon.node' ); * * @example * var v = maxf( NaN, 3.14 ); -* // returns 3.140000104904175 +* // returns ~3.14 * * @example * var v = maxf( -0.0, +0.0 ); From 494f1488f860766895561b73dc5725080b2606b4 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:16:16 -0700 Subject: [PATCH 12/13] docs: update example Signed-off-by: Athan --- .../base/special/fast/maxf/examples/index.js | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js index de9a0c73b401..03ae17bbf2f8 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/examples/index.js @@ -18,17 +18,14 @@ 'use strict'; -var minstd = require( '@stdlib/random/base/minstd-shuffle' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var maxf = require( './../lib' ); -var x; -var y; -var v; -var i; +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, -10.0, 10.0, opts ); +var y = uniform( x.length, -10.0, 10.0, opts ); -for ( i = 0; i < 100; i++ ) { - x = minstd(); - y = minstd(); - v = maxf( x, y ); - console.log( 'maxf(%d,%d) = %d', x, y, v ); -} +logEachMap( 'maxf(%0.4f,%0.4f) = %0.4f', x, y, maxf ); From fcb88ab4f67a883719f6e239abfa2949df386a10 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 19 Sep 2025 14:17:53 -0700 Subject: [PATCH 13/13] docs: update example Signed-off-by: Athan --- .../math/base/special/fast/maxf/README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md index d386f3647f43..2ec5fc1eacc4 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/README.md @@ -92,20 +92,17 @@ var v = maxf( 4.2, 3.14 ); ```javascript -var minstd = require( '@stdlib/random/base/minstd-shuffle' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var maxf = require( '@stdlib/math/base/special/fast/maxf' ); -var x; -var y; -var v; -var i; +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, -10.0, 10.0, opts ); +var y = uniform( x.length, -10.0, 10.0, opts ); -for ( i = 0; i < 100; i++ ) { - x = minstd(); - y = minstd(); - v = maxf( x, y ); - console.log( 'maxf(%d,%d) = %d', x, y, v ); -} +logEachMap( 'maxf(%0.4f,%0.4f) = %0.4f', x, y, maxf ); ```