diff --git a/lib/node_modules/@stdlib/math/base/special/logf/README.md b/lib/node_modules/@stdlib/math/base/special/logf/README.md new file mode 100644 index 000000000000..8a159148b33d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/README.md @@ -0,0 +1,198 @@ + + +# Logarithm + +> Compute the base `b` [logarithm][logarithm] of a single-precision floating-point number.. + +
+ +## Usage + +```javascript +var logf = require( '@stdlib/math/base/special/logf' ); +``` + +#### logf( x, b ) + +Computes the base `b` logarithm of a single-precision floating-point number. + +```javascript +var v = logf( 100.0, 10.0 ); +// returns 2.0 + +v = logf( 16.0, 2.0 ); +// returns 4.0 + +v = logf( 5.0, 1.0 ); +// returns Infinity +``` + +For negative `x` or `b`, the [logarithm][logarithm] is **not** defined. + +```javascript +var v = logf( -4.0, 1.0 ); +// returns NaN + +v = logf( 2.0, -4.0 ); +// returns NaN +``` + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var roundf = require( '@stdlib/math/base/special/roundf' ); +var logf = require( '@stdlib/math/base/special/logf' ); + +var b; +var x; +var i; + +for ( i = 0; i < 100; i++ ) { + x = roundf( randu() * 100.0 ); + b = roundf( randu() * 5.0 ); + console.log( 'logf( %d, %d ) = %d', x, b, logf( x, b ) ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/logf.h" +``` + +#### stdlib_base_logf( x, b ) + +Computes the base `b` logarithm of a single-precision floating-point number. + +```c +float v = stdlib_base_logf( 100.0f, 10.0f ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. +- **b**: `[in] float` input value. + +```c +float stdlib_base_logf( const float x, const float b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/logf.h" +#include +#include + +int main( void ) { + float out; + float x; + float b; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (float)rand() / (float)RAND_MAX ) * 100.0f; + b = ( (float)rand() / (float)RAND_MAX ) * 5.0f; + out = stdlib_base_logf( x, b ); + printf( "logf(%f, %f) = %f\n", x, b, out ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.js new file mode 100644 index 000000000000..457527d47144 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.js @@ -0,0 +1,55 @@ +/** +* @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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; +var logf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var base; + var x; + var y; + var i; + + x = randu( 100, 1.0, 1000.0 ); + base = discreteUniform( 100, 2.0, 10.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logf( x[ i % x.length ], base[ i % base.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/logf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..7488728309a2 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.native.js @@ -0,0 +1,64 @@ +/** +* @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 discreteUniform = require( '@stdlib/random/array/discrete-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 logf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var base; + var x; + var y; + var i; + + x = randu( 100, 1.0, 1000.0 ); + base = discreteUniform( 100, 2.0, 10.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logf( x[ i % x.length ], base[ i % base.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/logf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/logf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..f3866089e728 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf.h" +#include +#include +#include +#include +#include + +#define NAME "logf" +#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 b[ 100 ]; + float y; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = ( 100.0f * rand_float() ); + b[ i ] = ( 5.0f * rand_float() ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_logf( x[ i % 100 ], b[ 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/logf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/logf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/logf/docs/repl.txt new file mode 100644 index 000000000000..b29508d1c9d9 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/docs/repl.txt @@ -0,0 +1,39 @@ + +{{alias}}( x, b ) + Computes the base `b` logarithm of a single-precision floating-point number. + + For negative `b` or `x`, the function returns `NaN`. + + Parameters + ---------- + x: number + Input value. + + b: number + Base. + + Returns + ------- + y: number + Logarithm (base `b`). + + Examples + -------- + > var y = {{alias}}( 100.0, 10.0 ) + 2.0 + > y = {{alias}}( 16.0, 2.0 ) + 4.0 + > y = {{alias}}( 5.0, 1.0 ) + Infinity + > y = {{alias}}( NaN, 2.0 ) + NaN + > y = {{alias}}( 1.0, NaN ) + NaN + > y = {{alias}}( -4.0, 2.0 ) + NaN + > y = {{alias}}( 4.0, -2.0 ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/logf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/logf/docs/types/index.d.ts new file mode 100644 index 000000000000..f450682c36a3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/docs/types/index.d.ts @@ -0,0 +1,61 @@ +/* +* @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 + +/** +* Computes the base `b` logarithm of a single-precision floating-point number. +* +* @param x - input value +* @param b - base +* @returns logarithm (base `b`) +* +* @example +* var v = logf( 100.0, 10.0 ); +* // returns 2.0 +* +* @example +* var v = logf( 16.0, 2.0 ); +* // returns 4.0 +* +* @example +* var v = logf( 5.0, 1.0 ); +* // returns Infinity +* +* @example +* var v = logf( NaN, 2.0 ); +* // returns NaN +* +* @example +* var v = logf( 1.0, NaN ); +* // returns NaN +* +* @example +* var v = logf( -4.0, 2.0 ); +* // returns NaN +* +* @example +* var v = logf( 4.0, -2.0 ); +* // returns NaN +*/ +declare function logf( x: number, b: number ): number; + + +// EXPORTS // + +export = logf; diff --git a/lib/node_modules/@stdlib/math/base/special/logf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/logf/docs/types/test.ts new file mode 100644 index 000000000000..362cc7da3dcf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/docs/types/test.ts @@ -0,0 +1,56 @@ +/* +* @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 logf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + logf( 8, 2 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided values other than two numbers... +{ + logf( true, 3 ); // $ExpectError + logf( false, 2 ); // $ExpectError + logf( '5', 1 ); // $ExpectError + logf( [], 1 ); // $ExpectError + logf( {}, 2 ); // $ExpectError + logf( ( x: number ): number => x, 2 ); // $ExpectError + + logf( 9, true ); // $ExpectError + logf( 9, false ); // $ExpectError + logf( 5, '5' ); // $ExpectError + logf( 8, [] ); // $ExpectError + logf( 9, {} ); // $ExpectError + logf( 8, ( x: number ): number => x ); // $ExpectError + + logf( [], true ); // $ExpectError + logf( {}, false ); // $ExpectError + logf( false, '5' ); // $ExpectError + logf( {}, [] ); // $ExpectError + logf( '5', ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + logf(); // $ExpectError + logf( 3 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/logf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/logf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/logf/examples/c/example.c new file mode 100644 index 000000000000..1181b6250131 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf.h" +#include +#include + +int main( void ) { + float out; + float x; + float b; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (float)rand() / (float)RAND_MAX ) * 100.0f; + b = ( (float)rand() / (float)RAND_MAX ) * 5.0f; + out = stdlib_base_logf( x, b ); + printf( "logf(%f, %f) = %f\n", x, b, out ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/logf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/logf/examples/index.js new file mode 100644 index 000000000000..e04f893cb217 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/examples/index.js @@ -0,0 +1,33 @@ +/** +* @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 roundf = require( '@stdlib/math/base/special/roundf' ); +var logf = require( './../lib' ); + +var b; +var x; +var i; + +for ( i = 0; i < 100; i++ ) { + x = roundf( randu() * 100.0 ); + b = roundf( randu() * 5.0 ); + console.log( 'logf( %d, %d ) = %d', x, b, logf( x, b ) ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/logf/include.gypi b/lib/node_modules/@stdlib/math/base/special/logf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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.log", + "base", + "logarithm", + "log" + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/logf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/logf/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/logf/src/addon.c new file mode 100644 index 000000000000..600d1f5a1cb3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/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/logf.h" +#include "stdlib/math/base/napi/binary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_logf ) diff --git a/lib/node_modules/@stdlib/math/base/special/logf/src/main.c b/lib/node_modules/@stdlib/math/base/special/logf/src/main.c new file mode 100644 index 000000000000..11fcbe53f1a9 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/src/main.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/logf.h" +#include "stdlib/math/base/special/lnf.h" + +/** +* Computes the base `b` logarithm of a single-precision floating-point number. +* +* @param x input value +* @param b input value +* @return output value +* +* @example +* float out = stdlib_base_logf( 100.0f, 10.0f ); +* // returns 2.0f +*/ +float stdlib_base_logf( const float x, const float b ) { + return stdlib_base_lnf( x ) / stdlib_base_lnf( b ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/logf/test/test.js b/lib/node_modules/@stdlib/math/base/special/logf/test/test.js new file mode 100644 index 000000000000..c37ca04a7ec6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/test/test.js @@ -0,0 +1,83 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var roundf = require( '@stdlib/math/base/special/roundf' ); +var lnf = require( '@stdlib/math/base/special/lnf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var logf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof logf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has two parameters', function test( t ) { + t.equal( logf.length, 2.0, 'arity is 2' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN` as either of the arguments', function test( t ) { + t.equal( isnanf( logf( 2.0, NaN ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( NaN, 3.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a negative number as either of the arguments', function test( t ) { + t.equal( isnanf( logf( 2.0, -0.4 ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( -1.0, 3.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `1` or `0` for both arguments', function test( t ) { + t.equal( isnanf( logf( 0.0, 0.0 ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( 1.0, 1.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `1.0` if provided `x` and `b` such that `x = b` (except for zero and one)', function test( t ) { + var i; + for ( i = 2; i < 100; i++ ) { + t.equal( logf( i, i ), 1.0, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `lnf(x) / lnf(b)`', function test( t ) { + var b; + var x; + var i; + + for ( i = 0; i < 100; i++ ) { + x = float64ToFloat32( roundf( float64ToFloat32( randu() * 100.0 ) ) + EPS ); // eslint-disable-line max-len + b = float64ToFloat32( roundf( float64ToFloat32( randu() * 5.0 ) ) + EPS ); // eslint-disable-line max-len + t.equal( logf( x, b ), float64ToFloat32( lnf( x ) / lnf( b ) ), 'returns lnf(x) / lnf(b)' ); + } + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/logf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/logf/test/test.native.js new file mode 100644 index 000000000000..247859df9c13 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logf/test/test.native.js @@ -0,0 +1,92 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var roundf = require( '@stdlib/math/base/special/roundf' ); +var lnf = require( '@stdlib/math/base/special/lnf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var logf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof logf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has two parameters', opts, function test( t ) { + t.equal( logf.length, 2.0, 'arity is 2' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN` as either of the arguments', opts, function test( t ) { + t.equal( isnanf( logf( 2.0, NaN ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( NaN, 3.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a negative number as either of the arguments', opts, function test( t ) { + t.equal( isnanf( logf( 2.0, -0.4 ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( -1.0, 3.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `1` or `0` for both arguments', opts, function test( t ) { + t.equal( isnanf( logf( 0.0, 0.0 ) ), true, 'returns expected value' ); + t.equal( isnanf( logf( 1.0, 1.0 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `1.0` if provided `x` and `b` such that `x = b` (except for zero and one)', opts, function test( t ) { + var i; + for ( i = 2; i < 100; i++ ) { + t.equal( logf( i, i ), 1.0, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `lnf(x) / lnf(b)`', opts, function test( t ) { + var b; + var x; + var i; + + for ( i = 0; i < 100; i++ ) { + x = float64ToFloat32( roundf( float64ToFloat32( randu() * 100.0 ) ) + EPS ); // eslint-disable-line max-len + b = float64ToFloat32( roundf( float64ToFloat32( randu() * 5.0 ) ) + EPS ); // eslint-disable-line max-len + t.equal( logf( x, b ), float64ToFloat32( lnf( x ) / lnf( b ) ), 'returns lnf(x) / lnf(b)' ); + } + t.end(); +});