diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/README.md b/lib/node_modules/@stdlib/math/base/special/log1pmxf/README.md new file mode 100644 index 000000000000..6e308cab3d75 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/README.md @@ -0,0 +1,200 @@ + + +# log1pmxf + +> Evaluate `ln(1+x) - x` for a single-precision floating-point number. + +
+ +## Usage + +```javascript +var log1pmxf = require( '@stdlib/math/base/special/log1pmxf' ); +``` + +#### log1pmxf( x ) + +Evaluates `ln(1+x) - x` for a single-precision floating-point number. + +```javascript +var v = log1pmxf( 1.1 ); +// returns ~-0.358 + +v = log1pmxf( 0.99 ); +// returns ~-0.302 + +v = log1pmxf( -0.99 ); +// returns ~-3.615 + +v = log1pmxf( -1.1 ); +// returns NaN + +v = log1pmxf( NaN ); +// returns NaN +``` + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var log1pmxf = require( '@stdlib/math/base/special/log1pmxf' ); + +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, 0.0, 10.0, opts ); + +logEachMap( 'log1pmxf(%f) = %f', x, log1pmxf ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/log1pmxf.h" +``` + +#### stdlib_base_log1pmxf( x ) + +Evaluates `ln(1+x) - x` for a single-precision floating-point number. + +```c +float out = stdlib_base_log1pmxf( 1.1f ); +// returns ~-0.358f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. + +```c +float stdlib_base_log1pmxf( const float x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/log1pmxf.h" +#include +#include + +int main( void ) { + float x; + float v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (float)rand() / (float)RAND_MAX ) * 10.0f; + v = stdlib_base_log1pmxf( x ); + printf( "log1pmxf(%f) = %f\n", x, v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/math/base/special/lnf`][@stdlib/math/base/special/lnf]: evaluate the natural logarithm of a single-precision floating-point number. +- [`@stdlib/math/base/special/log1pf`][@stdlib/math/base/special/log1pf]: evaluate the natural logarithm of 1+x as a single-precision floating-point number. +- [`@stdlib/math/base/special/log1pmx`][@stdlib/math/base/special/log1pmx]: evaluate ln(1+x) - x. + +
+ + + + + +
+ + + +[@stdlib/math/base/special/lnf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/lnf + +[@stdlib/math/base/special/log1pf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/log1pf + +[@stdlib/math/base/special/log1pmx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/log1pmx + + + +
+ + diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.js new file mode 100644 index 000000000000..3ee5096f6299 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 log1pmxf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -1.0, 99.0, { + 'dtype': 'float32' + }); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = log1pmxf( x[ i%x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..739baa0525c6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/benchmark.native.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var log1pmxf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( log1pmxf instanceof Error ) +}; + + +// MAIN // + +bench( format( '%s::native', pkg ), opts, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -1.0, 99.0, { + 'dtype': 'float32' + }); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = log1pmxf( x[ i%x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..979768abbcec --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/log1pmxf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..37f8156b6bf7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/log1pmxf.h" +#include +#include +#include +#include +#include + +#define NAME "log1pmxf" +#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 random_uniform( const float min, const float max ) { + float v = (float)rand() / ( (float)RAND_MAX + 1.0f ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + float x[ 100 ]; + float y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( 0.0f, 100.0f ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_log1pmxf( x[ i%100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/log1pmxf/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/log1pmxf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/repl.txt new file mode 100644 index 000000000000..10183d6fe6c2 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/repl.txt @@ -0,0 +1,29 @@ + +{{alias}}( x ) + Evaluates `ln(1+x) - x` for a single-precision floating point number. + + Parameters + ---------- + x: number + Input value. + + Returns + ------- + y: number + Function value. + + Examples + -------- + > {{alias}}( 1.1 ) + ~-0.358 + > {{alias}}( 0.99 ) + ~-0.302 + > {{alias}}( -0.99 ) + ~-3.615 + > {{alias}}( -1.1 ) + NaN + > {{alias}}( NaN ) + NaN + + See Also + -------- diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/index.d.ts new file mode 100644 index 000000000000..b0cc6e134eea --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/index.d.ts @@ -0,0 +1,52 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 + +/** +* Evaluates \\( \operatorname{log1pmxf}(x) = \ln(1+x) - x \\) for a single-precision floating point number. +* +* @param x - input value +* @returns function value +* +* @example +* var v = log1pmxf( 1.1 ); +* // returns ~-0.358 +* +* @example +* var v = log1pmxf( 0.99 ); +* // returns ~-0.302 +* +* @example +* var v = log1pmxf( -0.99 ); +* // returns ~-3.615 +* +* @example +* var v = log1pmxf( -1.1 ); +* // returns NaN +* +* @example +* var v = log1pmxf( NaN ); +* // returns NaN +*/ +declare function log1pmxf( x: number ): number; + + +// EXPORTS // + +export = log1pmxf; diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/test.ts new file mode 100644 index 000000000000..305e866ee988 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/docs/types/test.ts @@ -0,0 +1,44 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 log1pmxf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + log1pmxf( 8 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + log1pmxf( true ); // $ExpectError + log1pmxf( false ); // $ExpectError + log1pmxf( null ); // $ExpectError + log1pmxf( undefined ); // $ExpectError + log1pmxf( '5' ); // $ExpectError + log1pmxf( [] ); // $ExpectError + log1pmxf( {} ); // $ExpectError + log1pmxf( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + log1pmxf(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/log1pmxf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/c/example.c new file mode 100644 index 000000000000..15718812cee7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/c/example.c @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/log1pmxf.h" +#include +#include + +int main( void ) { + float x; + float v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (float)rand() / (float)RAND_MAX ) * 10.0f; + v = stdlib_base_log1pmxf( x ); + printf( "x: %f, f(x): %f\n", x, v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/index.js new file mode 100644 index 000000000000..144433553e7f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/examples/index.js @@ -0,0 +1,30 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var log1pmxf = require( './../lib' ); + +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, 0.0, 10.0, opts ); + +logEachMap( 'log1pmxf(%f) = %f', x, log1pmxf ); diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/include.gypi b/lib/node_modules/@stdlib/math/base/special/log1pmxf/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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': [ + ' f32( 0.95 ) ) { + return f32( lnf( f32( ONE + x ) ) - x ); + } + + // Very small x: use first Taylor term + if ( ax < FLOAT_EPS ) { + return f32( -x * x / TWO ); + } + + opts = { + 'initialValue': f32( -x ) + }; + + return f32( sumSeries( log1pfSeries( x ), opts ) ); +} + + +// EXPORTS // + +module.exports = log1pmxf; diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/lib/native.js new file mode 100644 index 000000000000..fcd26728889b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/lib/native.js @@ -0,0 +1,62 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 // + +/** +* Evaluates \\( \operatorname{log1pmxf}(x) = \ln(1+x) - x \\) for a single-precision floating point number. +* +* @private +* @param {number} x - input value +* @returns {number} function value +* +* @example +* var v = log1pmxf( 1.1 ); +* // returns ~-0.358 +* +* @example +* var v = log1pmxf( 0.99 ); +* // returns ~-0.302 +* +* @example +* var v = log1pmxf( -0.99 ); +* // returns ~-3.615 +* +* @example +* var v = log1pmxf( -1.1 ); +* // returns NaN +* +* @example +* var v = log1pmxf( NaN ); +* // returns NaN +*/ +function log1pmxf( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = log1pmxf; diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/manifest.json b/lib/node_modules/@stdlib/math/base/special/log1pmxf/manifest.json new file mode 100644 index 000000000000..1ad7e29886f5 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/manifest.json @@ -0,0 +1,81 @@ +{ + "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/unary", + "@stdlib/math/base/special/log1pf", + "@stdlib/math/base/special/lnf", + "@stdlib/math/base/special/absf", + "@stdlib/constants/float32/eps" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/log1pf", + "@stdlib/math/base/special/lnf", + "@stdlib/math/base/special/absf", + "@stdlib/constants/float32/eps" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/log1pf", + "@stdlib/math/base/special/lnf", + "@stdlib/math/base/special/absf", + "@stdlib/constants/float32/eps" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/package.json b/lib/node_modules/@stdlib/math/base/special/log1pmxf/package.json new file mode 100644 index 000000000000..572b663ebd93 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/package.json @@ -0,0 +1,144 @@ +{ + "name": "@stdlib/math/base/special/log1pmxf", + "version": "0.0.0", + "description": "Evaluate ln(1+x) - x for a 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.log", + "math.log1p", + "log1pmxf", + "special functions", + "special", + "ln", + "natural", + "logarithm", + "log", + "function" + ], + "__stdlib__": { + "scaffold": { + "$schema": "math/base@v1.0", + "base_alias": "log1pmxf", + "alias": "log1pmxf", + "pkg_desc": "evaluate ln(1+x) - x for a single-precision floating point number", + "desc": "evaluates ln(1+x) - x for a single-precision floating point number", + "short_desc": "ln(1+x) - x", + "parameters": [ + { + "name": "x", + "desc": "input value", + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + }, + "domain": [ + { + "min": -1, + "max": "infinity" + } + ], + "rand": { + "prng": "random/base/uniform", + "parameters": [ + -1, + 100 + ] + }, + "example_values": [ + -0.99, + 1, + 2, + -0.9, + 0.25, + 0.5, + -0.5, + 10, + 25, + 50, + -0.25, + -0.1, + 0, + 0.01, + 3, + 4, + 5, + 75, + 90, + 100 + ] + } + ], + "output_policy": "real_floating_point_and_generic", + "returns": { + "desc": "function value", + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + } + }, + "keywords": [ + "ln", + "natural", + "logarithm", + "log" + ], + "extra_keywords": [] + } + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/log1pmxf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/addon.c new file mode 100644 index 000000000000..b96c26dd553e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/addon.c @@ -0,0 +1,22 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/log1pmxf.h" +#include "stdlib/math/base/napi/unary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_F_F( stdlib_base_log1pmxf ) diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/main.c b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/main.c new file mode 100644 index 000000000000..cceddf24f88b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/src/main.c @@ -0,0 +1,65 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +* +* +* ## Notice +* +* The original C++ code and copyright notice are from the [Boost library]{@link https://www.boost.org/doc/libs/1_83_0/boost/math/special_functions/log1p.hpp}. The implementation has been modified for C. +* +* ```text +* (C) Copyright John Maddock 2005-2006. +* +* Use, modification and distribution are subject to the +* Boost Software License, Version 1.0. (See accompanying file +* LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt) +* ``` +*/ + +#include "stdlib/math/base/special/log1pmxf.h" +#include "stdlib/math/base/special/log1pf.h" +#include "stdlib/math/base/special/lnf.h" +#include "stdlib/math/base/special/absf.h" +#include "stdlib/constants/float32/eps.h" + +/** +* Evaluates \\( \operatorname{log1pmxf}(x) = \ln(1+x) - x \\) for a single-precision floating point number. +* +* @param x input value +* @return output value +* +* @example +* float out = stdlib_base_log1pmxf( 1.1f ); +* // returns ~-0.358f +*/ +float stdlib_base_log1pmxf( const float x ) { + float ax; + if ( x <= -1.0f ) { + return 0.0f / 0.0f; // NaN + } + ax = stdlib_base_absf( x ); + + // Large |x|: safe direct computation + if ( ax > 0.95f ) { + return stdlib_base_lnf( 1.0f + x ) - x; + } + + // Very small x: use first Taylor term + if ( ax < STDLIB_CONSTANT_FLOAT32_EPS ) { + return -x * x / 2.0f; + } + return stdlib_base_log1pf( x ) - x; +} diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.js new file mode 100644 index 000000000000..c04432f10f62 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.js @@ -0,0 +1,99 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 linspace = require( '@stdlib/array/linspace' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var log1pf = require( '@stdlib/math/base/special/log1pf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var powf = require( '@stdlib/math/base/special/powf' ); +var lnf = require( '@stdlib/math/base/special/lnf' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var log1pmxf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof log1pmxf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if input is less than or equal to -1', function test( t ) { + var values = linspace( -1.0, -50.0, 100 ); + var i; + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( isnanf( log1pmxf( values[ i ] ) ), true, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function computes lnf(1+x) - x if |x| > 0.95', function test( t ) { + var expected; + var values = linspace( 0.951, 100.0, 100 ); + var actual; + var i; + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[i] ); + expected = f32( lnf( f32( 1.0 + values[i] ) ) - f32( values[i] ) ); + t.strictEqual( actual, expected, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns -x*x/2 if |x| < FLOAT_EPS', function test( t ) { + var expected; + var values = [ 0.0, EPS / 2.0 ]; + var actual; + var i; + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[i] ); + expected = f32( -powf( f32( values[i] ), 2 ) / 2.0 ); + t.strictEqual( actual, expected, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns a Taylor series expansion otherwise', function test( t ) { + var expected; + var values; + var actual; + var delta; + var tol; + var i; + + values = linspace( 0.1, 0.95, 100 ); + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[ i ] ); + expected = f32( log1pf( f32( values[ i ] ) ) - f32( values[ i ] ) ); + if ( actual === expected ) { + t.strictEqual( actual, expected, 'returns expected value' ); + } else { + delta = absf( f32( actual - expected ) ); + tol = f32( 100.0 * EPS * absf( expected ) ); + t.ok( delta <= tol, 'within tolerance. x: '+values[ i ]+'. actual: '+actual+'. expected: '+expected+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.native.js new file mode 100644 index 000000000000..a0c52bf0832e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/log1pmxf/test/test.native.js @@ -0,0 +1,108 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 linspace = require( '@stdlib/array/linspace' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var log1pf = require( '@stdlib/math/base/special/log1pf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var powf = require( '@stdlib/math/base/special/powf' ); +var lnf = require( '@stdlib/math/base/special/lnf' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var log1pmxf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( log1pmxf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof log1pmxf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if input is less than or equal to -1', opts, function test( t ) { + var values = linspace( -1.0, -50.0, 100 ); + var i; + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( isnanf( log1pmxf( values[ i ] ) ), true, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function computes lnf(1+x) - x if |x| > 0.95', opts, function test( t ) { + var expected; + var values = linspace( 0.951, 100.0, 100 ); + var actual; + var i; + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[i] ); + expected = f32( lnf( f32( 1.0 + values[i] ) ) - f32( values[i] ) ); + t.strictEqual( actual, expected, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns -x*x/2 if |x| < FLOAT_EPS', opts, function test( t ) { + var expected; + var values = [ 0.0, EPS / 2.0 ]; + var actual; + var i; + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[i] ); + expected = f32( -powf( f32( values[i] ), 2 ) / 2.0 ); + t.strictEqual( actual, expected, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns a Taylor series expansion otherwise', opts, function test( t ) { + var expected; + var values; + var actual; + var delta; + var tol; + var i; + + values = linspace( 0.1, 0.95, 100 ); + for ( i = 0; i < values.length; i++ ) { + actual = log1pmxf( values[ i ] ); + expected = f32( log1pf( f32( values[ i ] ) ) - f32( values[ i ] ) ); + if ( actual === expected ) { + t.strictEqual( actual, expected, 'returns expected value' ); + } else { + delta = absf( f32( actual - expected ) ); + tol = f32( 100.0 * EPS * absf( expected ) ); + t.ok( delta <= tol, 'within tolerance. x: '+values[ i ]+'. actual: '+actual+'. expected: '+expected+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +});