From 2a497989daf9a609e6ebcc8f5f28f764cc66b5fe Mon Sep 17 00:00:00 2001 From: Rutam Kathale Date: Mon, 11 Mar 2024 18:17:19 +0530 Subject: [PATCH 1/6] feat: add C implementation for @stdlib/math/base/special/xlogy This commit if applied adds the C implementation to @stdlib/math/base/special/xlogy package --- .../@stdlib/math/base/special/xlogy/README.md | 92 +++++++++- .../xlogy/benchmark/benchmark.native.js | 62 +++++++ .../special/xlogy/benchmark/c/native/Makefile | 146 +++++++++++++++ .../xlogy/benchmark/c/native/benchmark.c | 138 ++++++++++++++ .../math/base/special/xlogy/binding.gyp | 170 ++++++++++++++++++ .../base/special/xlogy/examples/c/Makefile | 146 +++++++++++++++ .../base/special/xlogy/examples/c/example.c | 35 ++++ .../math/base/special/xlogy/include.gypi | 53 ++++++ .../math/base/special/xlogy/include/xlogy.h | 38 ++++ .../math/base/special/xlogy/lib/native.js | 52 ++++++ .../math/base/special/xlogy/manifest.json | 74 ++++++++ .../math/base/special/xlogy/src/Makefile | 70 ++++++++ .../math/base/special/xlogy/src/addon.c | 23 +++ .../math/base/special/xlogy/src/main.c | 42 +++++ .../base/special/xlogy/test/test.native.js | 86 +++++++++ 15 files changed, 1226 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/include/xlogy.h create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/README.md b/lib/node_modules/@stdlib/math/base/special/xlogy/README.md index 1e3bda42f463..76fefde4d533 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/README.md +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2018 The Stdlib Authors. +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. @@ -89,6 +89,96 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/xlogy.h" +``` + +#### stdlib_base_xlogy( x, y ) + +Computes `x * ln(y)` so that the result is `0` if `x = 0`. + +```c +double v = stdlib_base_xlogy( 3.0, 2.0 ); +// returns ~2.079 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **y**: `[in] double` input value. + +```c +double stdlib_base_xlogy( const double x, const double y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/xlogy.h" +#include +#include + +int main( void ) { + double out; + double x; + double y; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (double)rand() / (double)RAND_MAX ) * 100.0; + y = ( (double)rand() / (double)RAND_MAX ) * 5.0; + out = stdlib_base_xlogy( x, y ); + printf( "xlogy(%lf, %lf) = %lf\n", x, y, out ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/benchmark.native.js new file mode 100644 index 000000000000..ebb3cc5b1e81 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/benchmark.native.js @@ -0,0 +1,62 @@ +/** +* @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/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var xlogy = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( xlogy instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var out; + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = ( randu()*100.0 ); + y = ( randu()*5.0 ); + out = xlogy( x, y ); + if ( isnan( out ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( out ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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/xlogy/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..66d0cedcebcd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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. +*/ + +/** +* Benchmark `xlogy`. +*/ +#include "stdlib/math/base/special/xlogy.h" +#include +#include +#include +#include +#include + +#define NAME "xlogy" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +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 +*/ +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 +*/ +double tic() { + 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 +*/ +double rand_double() { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +double benchmark() { + double elapsed; + double x; + double y; + double out; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( 100.0*rand_double() ); + y = ( 5.0*rand_double() ); + out = stdlib_base_xlogy( x, y ); + 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/xlogy/binding.gyp b/lib/node_modules/@stdlib/math/base/special/xlogy/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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/xlogy/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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/xlogy/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c new file mode 100644 index 000000000000..ca4ddb37551d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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/xlogy.h" +#include +#include + +int main( void ) { + double out; + double x; + double y; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( (double)rand() / (double)RAND_MAX ) * 100.0; + y = ( (double)rand() / (double)RAND_MAX ) * 5.0; + out = stdlib_base_xlogy( x, y ); + printf( "xlogy(%lf, %lf) = %lf\n", x, y, out ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/include.gypi b/lib/node_modules/@stdlib/math/base/special/xlogy/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/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': [ + ' Date: Mon, 11 Mar 2024 18:31:12 +0530 Subject: [PATCH 2/6] Update main.c - 'stdlib_base_isnan' -> 'stdlib_base_is_nan' Signed-off-by: Rutam <138517416+performant23@users.noreply.github.com> --- lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c b/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c index c2cc1b1bee0d..76862d8deba6 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c @@ -35,7 +35,7 @@ * // returns 0.0 */ double stdlib_base_xlogy( const double x, const double y ) { - if ( x == 0.0 && !stdlib_base_isnan( y ) ) { + if ( x == 0.0 && !stdlib_base_is_nan( y ) ) { return 0.0; } return x * stdlib_base_ln( y ); From c9a64c01376589bcfda9b476bc52a5e4f1c743f6 Mon Sep 17 00:00:00 2001 From: Rutam Kathale Date: Mon, 11 Mar 2024 18:36:41 +0530 Subject: [PATCH 3/6] feat: change file configuration for the header file --- .../special/xlogy/include/{ => stdlib/math/base/special}/xlogy.h | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename lib/node_modules/@stdlib/math/base/special/xlogy/include/{ => stdlib/math/base/special}/xlogy.h (100%) diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/include/xlogy.h b/lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/xlogy/include/xlogy.h rename to lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h From 6bf6229800813c4994fe0f1f9df5df22612d534c Mon Sep 17 00:00:00 2001 From: Rutam <138517416+performant23@users.noreply.github.com> Date: Mon, 11 Mar 2024 18:56:54 +0530 Subject: [PATCH 4/6] Update benchmark.c - variable usage revision Signed-off-by: Rutam <138517416+performant23@users.noreply.github.com> --- .../math/base/special/xlogy/benchmark/c/native/benchmark.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c index 66d0cedcebcd..7e68317f290c 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c @@ -105,13 +105,13 @@ double benchmark() { x = ( 100.0*rand_double() ); y = ( 5.0*rand_double() ); out = stdlib_base_xlogy( x, y ); - if ( y != y ) { + if ( out != out ) { printf( "should not return NaN\n" ); break; } } elapsed = tic() - t; - if ( y != y ) { + if ( out != out ) { printf( "should not return NaN\n" ); } return elapsed; From 20aaa176a9b59f04ee775653c8505bf07762398c Mon Sep 17 00:00:00 2001 From: Pranav <85227306+Pranavchiku@users.noreply.github.com> Date: Tue, 12 Mar 2024 18:42:03 +0530 Subject: [PATCH 5/6] chore: apply suggestions from code review Signed-off-by: Pranav <85227306+Pranavchiku@users.noreply.github.com> --- .../@stdlib/math/base/special/xlogy/README.md | 2 +- .../xlogy/benchmark/c/native/benchmark.c | 2 +- .../base/special/xlogy/examples/c/example.c | 20 +-- .../include/stdlib/math/base/special/xlogy.h | 2 +- .../math/base/special/xlogy/lib/native.js | 4 +- .../math/base/special/xlogy/manifest.json | 3 +- .../math/base/special/xlogy/src/main.c | 10 +- .../base/special/xlogy/test/test.native.js | 135 +++++++++++++++--- 8 files changed, 141 insertions(+), 37 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/README.md b/lib/node_modules/@stdlib/math/base/special/xlogy/README.md index 76fefde4d533..6347709a290c 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/README.md +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2024 The Stdlib Authors. +Copyright (c) 2018 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. diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c index 7e68317f290c..b196c5f018c4 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/benchmark/c/native/benchmark.c @@ -94,9 +94,9 @@ double rand_double() { */ double benchmark() { double elapsed; + double out; double x; double y; - double out; double t; int i; diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c index ca4ddb37551d..9979f07a4d34 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/examples/c/example.c @@ -21,15 +21,15 @@ #include int main( void ) { - double out; - double x; - double y; - int i; + double out; + double x; + double y; + int i; - for ( i = 0; i < 100; i++ ) { - x = ( (double)rand() / (double)RAND_MAX ) * 100.0; - y = ( (double)rand() / (double)RAND_MAX ) * 5.0; - out = stdlib_base_xlogy( x, y ); - printf( "xlogy(%lf, %lf) = %lf\n", x, y, out ); - } + for ( i = 0; i < 100; i++ ) { + x = ( (double)rand() / (double)RAND_MAX ) * 100.0; + y = ( (double)rand() / (double)RAND_MAX ) * 5.0; + out = stdlib_base_xlogy( x, y ); + printf( "xlogy(%lf, %lf) = %lf\n", x, y, out ); + } } diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h b/lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h index 05f557b4a13c..f1f811315b54 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/include/stdlib/math/base/special/xlogy.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Compute x * ln(y) so that the result is 0 if x = 0 where x and y are double-precision floating-point numbers. +* Computes `x * ln(y)` so that the result is `0` if `x = 0`. */ double stdlib_base_xlogy( const double x, const double y ); diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/lib/native.js b/lib/node_modules/@stdlib/math/base/special/xlogy/lib/native.js index 51d6eaa687dd..2558f5ab125a 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/lib/native.js @@ -26,12 +26,12 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes x * ln(y) so that the result is 0 if x = 0. +* Computes `x * ln(y)` so that the result is `0` if `x = 0`. * * @private * @param {number} x - input value * @param {number} y - input value -* @returns {number} output value +* @returns {number} function value * * @example * var v = xlogy( 3.0, 2.0 ); diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/manifest.json b/lib/node_modules/@stdlib/math/base/special/xlogy/manifest.json index f37e726abfc9..e6c6f160c4e8 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/manifest.json +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/manifest.json @@ -37,7 +37,8 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/napi/binary", - "@stdlib/math/base/special/ln" + "@stdlib/math/base/special/ln", + "@stdlib/math/base/assert/is-nan" ] }, { diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c b/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c index 76862d8deba6..fd2bd3e8e480 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/src/main.c @@ -20,7 +20,7 @@ #include "stdlib/math/base/assert/is_nan.h" /** -* Computes x * ln(y) so that the result is 0 if x = 0. +* Computes `x * ln(y)` so that the result is `0` if `x = 0`. * * @param x input value * @param y input value @@ -35,8 +35,8 @@ * // returns 0.0 */ double stdlib_base_xlogy( const double x, const double y ) { - if ( x == 0.0 && !stdlib_base_is_nan( y ) ) { - return 0.0; - } - return x * stdlib_base_ln( y ); + if ( x == 0.0 && !stdlib_base_is_nan( y ) ) { + return 0.0; + } + return x * stdlib_base_ln( y ); } diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js index fb892885bbe0..e43c7341d48f 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js @@ -30,6 +30,14 @@ var EPS = require( '@stdlib/constants/float64/eps' ); var tryRequire = require( '@stdlib/utils/try-require' ); +// FIXTURES // + +var smallSmall = require( './fixtures/python/small_small.json' ); +var smallLarge = require( './fixtures/python/small_large.json' ); +var largeSmall = require( './fixtures/python/large_small.json' ); +var largeLarge = require( './fixtures/python/large_large.json' ); + + // VARIABLES // var xlogy = tryRequire( resolve( __dirname, './../lib/native.js' ) ); @@ -46,41 +54,136 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'the function has two parameters', opts, function test( t ) { - t.equal( xlogy.length, 2.0, 'arity is 2' ); +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof xlogy, 'function', 'main export is a function' ); t.end(); }); -tape( 'the function returns `NaN` if provided `NaN` as either of the arguments', opts, function test( t ) { - t.equal( isnan( xlogy( 2.0, NaN ) ), true, 'returns NaN' ); - t.equal( isnan( xlogy( NaN, 3.0 ) ), true, 'returns NaN' ); +tape( 'the function returns `NaN` when provided `NaN` for any parameter', opts, function test( t ) { + var out = xlogy( NaN, 2.0 ); + t.strictEqual( isnan( out ), true, 'returns NaN' ); + + out = xlogy( 0.0, NaN ); + t.strictEqual( isnan( out ), true, 'returns NaN' ); + + out = xlogy( 3.4, NaN ); + t.strictEqual( isnan( out ), true, 'returns NaN' ); + + out = xlogy( NaN, NaN ); + t.strictEqual( isnan( out ), true, 'returns NaN' ); t.end(); }); -tape( 'the function returns `NaN` if provided a negative number for `y`', opts, function test( t ) { - t.equal( isnan( xlogy( 2.0, -0.4 ) ), true, 'returns NaN' ); +tape( 'the function returns `0` when `x = 0` and `y` is a number', opts, function test( t ) { + var out = xlogy( 0.0, 2.0 ); + t.strictEqual( out, 0.0, 'returns 0' ); + + out = xlogy( 0.0, 0.0 ); + t.strictEqual( out, 0.0, 'returns 0' ); + + out = xlogy( 0.0, -3.0 ); + t.strictEqual( out, 0.0, 'returns 0' ); + t.end(); }); -tape( 'the function returns `NaN` if provided `0` for `y`', opts, function test( t ) { - t.equal( isnan( xlogy( 2.0, 0.0 ) ), true, 'returns NaN' ); +tape( 'the function evaluates `x * ln(y)` for small `x` and `y`', opts, function test( t ) { + var expected; + var delta; + var out; + var tol; + var x; + var y; + var i; + + expected = smallSmall.expected; + x = smallSmall.x; + y = smallSmall.y; + for ( i = 0; i < x.length; i++ ) { + out = xlogy( x[i], y[i] ); + if ( out === expected[i] ) { + t.strictEqual( out, expected[i], 'x: '+x[i]+', out: '+out+', expected: '+expected[i] ); + } else { + delta = abs( out - expected[i] ); + tol = 2.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. v: '+out+'. E: '+expected[i]+' Δ: '+delta+'. tol: '+tol ); + } + } t.end(); }); -tape( 'the function returns `0` if provided `0` for `x` and not `NaN` for `y`', opts, function test( t ) { - t.equal( xlogy( 0.0, 2.0 ), 0.0, 'returns 0' ); +tape( 'the function evaluates `x * ln(y)` for small `x` and large `y`', opts, function test( t ) { + var expected; + var delta; + var out; + var tol; + var x; + var y; + var i; + + expected = smallLarge.expected; + x = smallLarge.x; + y = smallLarge.y; + for ( i = 0; i < x.length; i++ ) { + out = xlogy( x[i], y[i] ); + if ( out === expected[i] ) { + t.strictEqual( out, expected[i], 'x: '+x[i]+', out: '+out+', expected: '+expected[i] ); + } else { + delta = abs( out - expected[i] ); + tol = 2.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. v: '+out+'. E: '+expected[i]+' Δ: '+delta+'. tol: '+tol ); + } + } t.end(); }); -tape( 'the function returns `x * ln(y)`', opts, function test( t ) { +tape( 'the function evaluates `x * ln(y)` for large `x` and small `y`', opts, function test( t ) { + var expected; + var delta; + var out; + var tol; + var x; var y; + var i; + + expected = largeSmall.expected; + x = largeSmall.x; + y = largeSmall.y; + for ( i = 0; i < x.length; i++ ) { + out = xlogy( x[i], y[i] ); + if ( out === expected[i] ) { + t.strictEqual( out, expected[i], 'x: '+x[i]+', out: '+out+', expected: '+expected[i] ); + } else { + delta = abs( out - expected[i] ); + tol = 2.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. v: '+out+'. E: '+expected[i]+' Δ: '+delta+'. tol: '+tol ); + } + } + t.end(); +}); + +tape( 'the function evaluates `x * ln(y)` for large `x` and `y`', opts, function test( t ) { + var expected; + var delta; + var out; + var tol; var x; + var y; var i; - for ( i = 0; i < 100; i++ ) { - x = round( randu() * 100.0 ) + EPS; - y = round( randu() * 5.0 ) + EPS; - t.equal( xlogy( x, y ), x * ln( y ), 'returns x * ln(y)' ); + expected = largeLarge.expected; + x = largeLarge.x; + y = largeLarge.y; + for ( i = 0; i < x.length; i++ ) { + out = xlogy( x[i], y[i] ); + if ( out === expected[i] ) { + t.strictEqual( out, expected[i], 'x: '+x[i]+', out: '+out+', expected: '+expected[i] ); + } else { + delta = abs( out - expected[i] ); + tol = 2.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. v: '+out+'. E: '+expected[i]+' Δ: '+delta+'. tol: '+tol ); + } } t.end(); }); From e4cc1e41c2d47337294332dc0948387e51be9bbc Mon Sep 17 00:00:00 2001 From: Pranav <85227306+Pranavchiku@users.noreply.github.com> Date: Tue, 12 Mar 2024 18:44:05 +0530 Subject: [PATCH 6/6] chore: apply suggestions from code review Signed-off-by: Pranav <85227306+Pranavchiku@users.noreply.github.com> --- .../@stdlib/math/base/special/xlogy/test/test.native.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js index e43c7341d48f..2ab0b69a14ab 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/xlogy/test/test.native.js @@ -23,9 +23,7 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var ln = require( '@stdlib/math/base/special/ln' ); +var abs = require( '@stdlib/math/base/special/abs' ); var EPS = require( '@stdlib/constants/float64/eps' ); var tryRequire = require( '@stdlib/utils/try-require' );