From 9df81c881a36ae4b5b08eac13319869283d51867 Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Sun, 25 Aug 2024 10:28:52 +0530 Subject: [PATCH 1/2] feat: add math/base/special/minabsf --- .../math/base/special/minabsf/README.md | 225 ++++++++++++++++++ .../special/minabsf/benchmark/benchmark.js | 54 +++++ .../minabsf/benchmark/benchmark.native.js | 63 +++++ .../minabsf/benchmark/c/native/Makefile | 146 ++++++++++++ .../minabsf/benchmark/c/native/benchmark.c | 138 +++++++++++ .../math/base/special/minabsf/binding.gyp | 170 +++++++++++++ .../math/base/special/minabsf/docs/repl.txt | 39 +++ .../special/minabsf/docs/types/index.d.ts | 49 ++++ .../base/special/minabsf/docs/types/test.ts | 51 ++++ .../base/special/minabsf/examples/c/Makefile | 146 ++++++++++++ .../base/special/minabsf/examples/c/example.c | 35 +++ .../base/special/minabsf/examples/index.js | 34 +++ .../math/base/special/minabsf/include.gypi | 53 +++++ .../stdlib/math/base/special/minabsf.h | 38 +++ .../math/base/special/minabsf/lib/index.js | 46 ++++ .../math/base/special/minabsf/lib/main.js | 56 +++++ .../math/base/special/minabsf/lib/native.js | 59 +++++ .../math/base/special/minabsf/manifest.json | 75 ++++++ .../math/base/special/minabsf/package.json | 69 ++++++ .../math/base/special/minabsf/src/Makefile | 70 ++++++ .../math/base/special/minabsf/src/addon.c | 23 ++ .../math/base/special/minabsf/src/main.c | 40 ++++ .../math/base/special/minabsf/test/test.js | 88 +++++++ .../base/special/minabsf/test/test.native.js | 97 ++++++++ 24 files changed, 1864 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/README.md create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/examples/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/include/stdlib/math/base/special/minabsf.h create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/lib/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/lib/main.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/package.json create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/test/test.js create mode 100644 lib/node_modules/@stdlib/math/base/special/minabsf/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/README.md b/lib/node_modules/@stdlib/math/base/special/minabsf/README.md new file mode 100644 index 000000000000..7298c31b1795 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/README.md @@ -0,0 +1,225 @@ + + +# minabsf + +> Return the minimum absolute single-precision floating-point number. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var minabsf = require( '@stdlib/math/base/special/minabsf' ); +``` + +#### minabsf( x, y ) + +Returns the minimum absolute single-precision floating-point number. + +```javascript +var v = minabsf( -4.2, 3.14 ); +// returns ~3.14 + +v = minabsf( +0.0, -0.0 ); +// returns +0.0 +``` + +If any argument is `NaN`, the function returns `NaN`. + +```javascript +var v = minabsf( 4.2, NaN ); +// returns NaN + +v = minabsf( NaN, 3.14 ); +// returns NaN +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var minabsf = require( '@stdlib/math/base/special/minabsf' ); + +var x; +var y; +var v; +var i; + +for ( i = 0; i < 100; i++ ) { + x = ( randu() * 1000.0 ) - 500.0; + y = ( randu() * 1000.0 ) - 500.0; + v = minabsf( x, y ); + console.log( 'minabsf(%d,%d) = %d', x, y, v ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/minabsf.h" +``` + +#### stdlib_base_minabsf( x, y ) + +Returns the minimum absolute single-precision floating-point number. + +```c +float out = stdlib_base_minabsf( -4.2f, 3.14f ); +// returns 3.14f + +out = stdlib_base_minabsf( 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_minabsf( const float x, const float y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/minabsf.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 ) * 1000.0f ) - 500.0f; + y = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f; + v = stdlib_base_minabsf( x, y ); + printf( "x: %f, y: %f, minabsf(x, y): %f\n", x, y, v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.js new file mode 100644 index 000000000000..740a6f27d275 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; +var minabsf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var z; + var i; + + x = randu( 100, -500.0, 500.0 ); + y = randu( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = minabsf( 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/minabsf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..010b41ef74a6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/benchmark.native.js @@ -0,0 +1,63 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/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 minabsf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( minabsf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var z; + var i; + + x = randu( 100, -500.0, 500.0 ); + y = randu( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = minabsf( 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/minabsf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..72fe89a55947 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/benchmark/c/native/benchmark.c @@ -0,0 +1,138 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/minabsf.h" +#include +#include +#include +#include +#include + +#define NAME "minabsf" +#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; + double t; + float x[ 100 ]; + float y[ 100 ]; + float z; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = ( 1000.0f * rand_float() ) - 500.0f; + y[ i ] = ( 1000.0f * rand_float() ) - 500.0f; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + z = stdlib_base_minabsf( 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/minabsf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/minabsf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt new file mode 100644 index 000000000000..2b7d296e33ff --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt @@ -0,0 +1,39 @@ + +{{alias}}( x, y ) + Returns the minimum absolute absolute single-precision + floating-point number. + + If any argument is `NaN`, the function returns `NaN`. + + When an empty set is considered a subset of the extended reals (all real + numbers, including positive and negative infinity), positive infinity is the + greatest upper bound. Similar to zero being the identity element for the sum + of an empty set and to one being the identity element for the product of an + empty set, positive infinity is the identity element for the minimum, and + thus, if not provided any arguments, the function returns positive infinity. + + Parameters + ---------- + x: number + First number. + + y: number + Second number. + + Returns + ------- + out: number + Minimum absolute value. + + Examples + -------- + > var v = {{alias}}( 3.14, -4.2 ) + ~3.14 + > v = {{alias}}( 3.14, NaN ) + NaN + > v = {{alias}}( +0.0, -0.0 ) + +0.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts new file mode 100644 index 000000000000..b6c03dbec171 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts @@ -0,0 +1,49 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns the minimum absolute single-precision floating-point number. +* +* ## Notes +* +* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity. +* +* @param x - first number +* @param y - second number +* @returns minimum absolute value +* +* @example +* var v = minabsf( -3.14, 4.2 ); +* // returns ~3.14 +* +* @example +* var v = minabsf( 3.14, NaN ); +* // returns NaN +* +* @example +* var v = minabsf( +0.0, -0.0 ); +* // returns +0.0 +*/ +declare function minabsf( x: number, y: number ): number; + + +// EXPORTS // + +export = minabsf; diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/test.ts new file mode 100644 index 000000000000..fc1b8ff5eefd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/test.ts @@ -0,0 +1,51 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import minabsf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + minabsf( 3, -0.2 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided non-number arguments... +{ + minabsf( true, 3 ); // $ExpectError + minabsf( false, 3 ); // $ExpectError + minabsf( [], 3 ); // $ExpectError + minabsf( {}, 3 ); // $ExpectError + minabsf( 'abc', 3 ); // $ExpectError + minabsf( ( x: number ): number => x, 3 ); // $ExpectError + + minabsf( 1.2, true ); // $ExpectError + minabsf( 1.2, false ); // $ExpectError + minabsf( 1.2, [] ); // $ExpectError + minabsf( 1.2, {} ); // $ExpectError + minabsf( 1.2, 'abc' ); // $ExpectError + minabsf( 1.2, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + minabsf(); // $ExpectError + minabsf( -0.2 ); // $ExpectError + minabsf( 3, -0.2, -1.2, -4.0 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/example.c new file mode 100644 index 000000000000..7672395c311f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/c/example.c @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/minabsf.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 ) * 1000.0f ) - 500.0f; + y = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f; + v = stdlib_base_minabsf( x, y ); + printf( "x: %f, y: %f, minabsf(x, y): %f\n", x, y, v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/index.js new file mode 100644 index 000000000000..0ed0a319ed5d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var randu = require( '@stdlib/random/base/randu' ); +var minabsf = require( './../lib' ); + +var x; +var y; +var v; +var i; + +for ( i = 0; i < 100; i++ ) { + x = ( randu() * 1000.0 ) - 500.0; + y = ( randu() * 1000.0 ) - 500.0; + v = minabsf( x, y ); + console.log( 'minabsf(%d,%d) = %d', x, y, v ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/include.gypi b/lib/node_modules/@stdlib/math/base/special/minabsf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "math.min", + "math.abs", + "minimum", + "min", + "smallest", + "absolute", + "value", + "abs", + "minabs" + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/minabsf/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/minabsf/src/addon.c new file mode 100644 index 000000000000..5869e55c8557 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/minabsf.h" +#include "stdlib/math/base/napi/binary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_minabsf ) diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/src/main.c b/lib/node_modules/@stdlib/math/base/special/minabsf/src/main.c new file mode 100644 index 000000000000..382b8b8be63b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/src/main.c @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/minabsf.h" +#include "stdlib/math/base/special/minf.h" +#include "stdlib/math/base/special/absf.h" + +/** +* Returns the minimum absolute single-precision floating-point number. +* +* @param x first number +* @param y second number +* @return minimum absolute value +* +* @example +* float v = stdlib_base_minabsf( 3.14f, -4.2f ); +* // returns ~3.14f +* +* @example +* float v = stdlib_base_minabsf( 0.0f, -0.0f ); +* // returns +0.0f +*/ +float stdlib_base_minabsf( const float x, const float y ) { + return stdlib_base_minf( stdlib_base_absf( x ), stdlib_base_absf( y ) ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.js b/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.js new file mode 100644 index 000000000000..95f6cbf6a9ff --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.js @@ -0,0 +1,88 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var minabsf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof minabsf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', function test( t ) { + var v; + + v = minabsf( NaN, 3.14 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = minabsf( 3.14, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = minabsf( NaN, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a correctly signed zero', function test( t ) { + var v; + + v = minabsf( +0.0, -0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( -0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( -0.0, -0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( +0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the minimum absolute value', function test( t ) { + var v; + + v = minabsf( float64ToFloat32( 4.2 ), float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( float64ToFloat32( -4.2 ), float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( PINF, float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( float64ToFloat32( 3.14 ), PINF ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.native.js new file mode 100644 index 000000000000..005420c16741 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/test/test.native.js @@ -0,0 +1,97 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var minabsf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( minabsf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof minabsf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', opts, function test( t ) { + var v; + + v = minabsf( NaN, 3.14 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = minabsf( 3.14, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = minabsf( NaN, NaN ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a correctly signed zero', opts, function test( t ) { + var v; + + v = minabsf( +0.0, -0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( -0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( -0.0, -0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + v = minabsf( +0.0, +0.0 ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the minimum absolute value', opts, function test( t ) { + var v; + + v = minabsf( float64ToFloat32( 4.2 ), float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( float64ToFloat32( -4.2 ), float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( PINF, float64ToFloat32( 3.14 ) ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + v = minabsf( float64ToFloat32( 3.14 ), PINF ); + t.strictEqual( v, float64ToFloat32( 3.14 ), 'returns expected value' ); + + t.end(); +}); From 265a0f96b4783493b22d7f9a07dd75402fa23f58 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 31 Aug 2024 17:10:01 -0400 Subject: [PATCH 2/2] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/math/base/special/minabsf/docs/repl.txt | 7 ------- .../math/base/special/minabsf/docs/types/index.d.ts | 4 ---- 2 files changed, 11 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt index 2b7d296e33ff..c77a7b8df1a3 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt @@ -5,13 +5,6 @@ If any argument is `NaN`, the function returns `NaN`. - When an empty set is considered a subset of the extended reals (all real - numbers, including positive and negative infinity), positive infinity is the - greatest upper bound. Similar to zero being the identity element for the sum - of an empty set and to one being the identity element for the product of an - empty set, positive infinity is the identity element for the minimum, and - thus, if not provided any arguments, the function returns positive infinity. - Parameters ---------- x: number diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts index b6c03dbec171..11c8a3a336c2 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts @@ -21,10 +21,6 @@ /** * Returns the minimum absolute single-precision floating-point number. * -* ## Notes -* -* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity. -* * @param x - first number * @param y - second number * @returns minimum absolute value