From f841e0bda36bfd9b6e5114228151252653f9713a Mon Sep 17 00:00:00 2001 From: Rejoan Sardar Date: Sat, 16 Mar 2024 10:29:13 +0530 Subject: [PATCH 01/10] feat: @stdlib/math/base/special/fast/atanh --- .../math/base/special/fast/atanh/README.md | 88 +++++++++ .../fast/atanh/benchmark/benchmark.native.js | 61 +++++++ .../fast/atanh/benchmark/c/native/Makefile | 146 +++++++++++++++ .../fast/atanh/benchmark/c/native/benchmark.c | 136 ++++++++++++++ .../math/base/special/fast/atanh/binding.gyp | 170 ++++++++++++++++++ .../special/fast/atanh/examples/c/Makefile | 146 +++++++++++++++ .../special/fast/atanh/examples/c/example.c | 31 ++++ .../math/base/special/fast/atanh/include.gypi | 53 ++++++ .../stdlib/math/base/special/fast/atanh.h | 38 ++++ .../base/special/fast/atanh/lib/native.js | 62 +++++++ .../base/special/fast/atanh/manifest.json | 81 +++++++++ .../math/base/special/fast/atanh/src/Makefile | 70 ++++++++ .../math/base/special/fast/atanh/src/addon.c | 23 +++ .../math/base/special/fast/atanh/src/main.c | 44 +++++ .../special/fast/atanh/test/test.native.js | 170 ++++++++++++++++++ 15 files changed, 1319 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/include/stdlib/math/base/special/fast/atanh.h create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/fast/atanh/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md index 707213322c7f..6003199934fd 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md @@ -103,6 +103,94 @@ for ( i = 0; i < x.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/fast/atanh.h" +``` + +#### stdlib_base_fast_atanh( x ) + +Computes the [hyperbolic arctangent][inverse-hyperbolic] of double-precision floating-point number. + +```c +double out = stdlib_base_fast_atanh( 1.0 ); +// returns 0.0 + +out = stdlib_base_fast_atanh( 2.0 ); +// returns ~1.317 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_fast_atanh( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/fast/atanh.h" +#include + +int main( void ) { + const double x[] = { 1.0, 1.45, 1.89, 2.33, 2.78, 3.22, 3.66, 4.11, 4.55, 5.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_fast_atanh( x[ i ] ); + printf( "atanh(%lf) = %lf\n", x[ i ], v ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/benchmark.native.js new file mode 100644 index 000000000000..de8cfd9a2abb --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/benchmark.native.js @@ -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. +*/ + +'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 atanh = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( atanh instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = ( randu() * 2.0 ) - 1.0; + y = atanh( x ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } else { + b.pass( 'benchmark finished' ); + } + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/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/fast/atanh/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..a1c5045d6d53 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @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 `atanh`. +*/ +#include "stdlib/math/base/special/fast/atanh.h" +#include +#include +#include +#include +#include + +#define NAME "atanh" +#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 t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( rand_double() * 2.0 ) - 1.0; + y = stdlib_base_fast_atanh( x ); + 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/fast/atanh/binding.gyp b/lib/node_modules/@stdlib/math/base/special/fast/atanh/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/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/fast/atanh/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/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/fast/atanh/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c new file mode 100644 index 000000000000..a7c015297180 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @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/fast/atanh.h" +#include + +int main( void ) { + const double x[] = { 1.0, 1.45, 1.89, 2.33, 2.78, 3.22, 3.66, 4.11, 4.55, 5.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_fast_atanh( x[ i ] ); + printf( "atanh(%lf) = %lf\n", x[ i ], v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/include.gypi b/lib/node_modules/@stdlib/math/base/special/fast/atanh/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/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': [ + ' + +/** +* Computes the hyperbolic arctangent of a number. +* +* @param x input value +* @returns hyperbolic arctangent (in radians) +* +* @example +* double v = stdlib_base_fast_atanh( 0.0 ); +* // returns 0.0 +*/ +double stdlib_base_fast_atanh( const double x ) { + if ( x == 0.0 ) { + return x; + } + if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) ) { + return 0.0 / 0.0 ; // NaN + } + return 0.5 * stdlib_base_ln( (1.0+x) / (1.0-x) ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/fast/atanh/test/test.native.js new file mode 100644 index 000000000000..ebd5d268b4b9 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/test/test.native.js @@ -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. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var randu = require( '@stdlib/random/base/randu' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var atanh = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( atanh instanceof Error ) +}; + + +// FIXTURES // + +var negative = require( './fixtures/julia/negative.json' ); +var positive = require( './fixtures/julia/positive.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof atanh, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the hyperbolic arctangent (negative values)', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var y; + var i; + + x = negative.x; + expected = negative.expected; + + for ( i = 0; i < x.length; i++ ) { + y = atanh( x[i] ); + if ( y === expected[ i ] ) { + t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); + } else { + delta = abs( y - expected[i] ); + tol = 500.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. Value: '+y+'. Expected: '+expected[i]+'. Delta: '+delta+' Tolerance: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function computes the hyperbolic arctangent (positive values)', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var y; + var i; + + x = positive.x; + expected = positive.expected; + + for ( i = 0; i < x.length; i++ ) { + y = atanh( x[i] ); + if ( y === expected[ i ] ) { + t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); + } else { + delta = abs( y - expected[i] ); + tol = 650.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. Value: '+y+'. Expected: '+expected[i]+'. Delta: '+delta+' Tolerance: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function underflows if provided a value negligible compared to unity (negative)', opts, function test( t ) { + var x = -EPS / 10.0; + var v = atanh( x ); + t.strictEqual( isPositiveZero( v ), true, 'returns 0' ); + t.end(); +}); + +tape( 'the function underflows if provided a value negligible compared to unity (positive)', opts, function test( t ) { + var x = EPS / 10.0; + var v = atanh( x ); + t.strictEqual( isPositiveZero( v ), true, 'returns 0' ); + t.end(); +}); + +tape( 'the function returns `+Infinity` if provided `1.0`', opts, function test( t ) { + var v = atanh( 1.0 ); + t.strictEqual( v, PINF, 'returns +Infinity' ); + t.end(); +}); + +tape( 'the function returns `-Infinity` if provided `-1.0`', opts, function test( t ) { + var v = atanh( -1.0 ); + t.strictEqual( v, NINF, 'returns -Infinity' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a value less than `-1`', opts, function test( t ) { + var v; + var i; + + for ( i = 0; i < 1e3; i++ ) { + v = -(randu()*1.0e6) - (1.0+EPS); + t.strictEqual( isnan( atanh( v ) ), true, 'returns NaN when provided '+v ); + } + t.end(); +}); + +tape( 'the function returns `NaN` if provided a value greater than `1`', opts, function test( t ) { + var v; + var i; + + for ( i = 0; i < 1e3; i++ ) { + v = ( randu()*1.0e6 ) + 1.0 + EPS; + t.strictEqual( isnan( atanh( v ) ), true, 'returns NaN when provided '+v ); + } + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v = atanh( -0.0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', opts, function test( t ) { + var v = atanh( 0.0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns 0' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', opts, function test( t ) { + var v = atanh( NaN ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + t.end(); +}); From d725edc7cf664ca7fc588eda7448c5a8abf8c9c9 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:10:03 +0530 Subject: [PATCH 02/10] Update README.md Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../@stdlib/math/base/special/fast/atanh/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md index 6003199934fd..fc294866fd7a 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md @@ -131,14 +131,14 @@ for ( i = 0; i < x.length; i++ ) { #### stdlib_base_fast_atanh( x ) -Computes the [hyperbolic arctangent][inverse-hyperbolic] of double-precision floating-point number. +Computes the [hyperbolic arctangent][inverse-hyperbolic] of a double-precision floating-point number (in radians). ```c -double out = stdlib_base_fast_atanh( 1.0 ); +double out = stdlib_base_fast_atanh( 0.0 ); // returns 0.0 -out = stdlib_base_fast_atanh( 2.0 ); -// returns ~1.317 +out = stdlib_base_fast_atanh( -0.0 ); +// returns -0.0 ``` The function accepts the following arguments: @@ -172,7 +172,7 @@ double stdlib_base_fast_atanh( const double x ); #include int main( void ) { - const double x[] = { 1.0, 1.45, 1.89, 2.33, 2.78, 3.22, 3.66, 4.11, 4.55, 5.0 }; + const double x[] = { 0.0, -0.0, 0.3, 0.6, 0.9, -1.0, 1.0, 3.66, 4.11, 5.0 }; double v; int i; From 9ff041223fe9565afe639c27da91b5396b34e9db Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:17:35 +0530 Subject: [PATCH 03/10] Update example.c Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../base/special/fast/atanh/examples/c/example.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c index a7c015297180..f787a9a7de36 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/examples/c/example.c @@ -20,12 +20,12 @@ #include int main( void ) { - const double x[] = { 1.0, 1.45, 1.89, 2.33, 2.78, 3.22, 3.66, 4.11, 4.55, 5.0 }; + const double x[] = { -1.0, -0.78, -0.56, -0.33, -0.11, 0.11, 0.33, 0.56, 0.78, 1.0 }; - double v; - int i; - for ( i = 0; i < 10; i++ ) { - v = stdlib_base_fast_atanh( x[ i ] ); - printf( "atanh(%lf) = %lf\n", x[ i ], v ); - } + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_fast_atanh( x[ i ] ); + printf( "atanh(%lf) = %lf\n", x[ i ], v ); + } } From 01767a74f48a6cfe8e66e64fd52c5f647112fafd Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:18:45 +0530 Subject: [PATCH 04/10] Update README.md Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../math/base/special/fast/atanh/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md index fc294866fd7a..fcd67dd53b31 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md @@ -172,14 +172,14 @@ double stdlib_base_fast_atanh( const double x ); #include int main( void ) { - const double x[] = { 0.0, -0.0, 0.3, 0.6, 0.9, -1.0, 1.0, 3.66, 4.11, 5.0 }; - - double v; - int i; - for ( i = 0; i < 10; i++ ) { - v = stdlib_base_fast_atanh( x[ i ] ); - printf( "atanh(%lf) = %lf\n", x[ i ], v ); - } + const double x[] = { -1.0, -0.78, -0.56, -0.33, -0.11, 0.11, 0.33, 0.56, 0.78, 1.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_fast_atanh( x[ i ] ); + printf( "atanh(%lf) = %lf\n", x[ i ], v ); + } } ``` From d70b1da9de91e8f66ee5aefb42d53da07309cb82 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:22:11 +0530 Subject: [PATCH 05/10] Update atanh.h Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../fast/atanh/include/stdlib/math/base/special/fast/atanh.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/include/stdlib/math/base/special/fast/atanh.h b/lib/node_modules/@stdlib/math/base/special/fast/atanh/include/stdlib/math/base/special/fast/atanh.h index b739f85f2ccb..54b3e92f58f2 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/include/stdlib/math/base/special/fast/atanh.h +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/include/stdlib/math/base/special/fast/atanh.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Computes the hyperbolic arctangent of double-precision floating-point number. +* Computes the hyperbolic arctangent of a double-precision floating-point number. */ double stdlib_base_fast_atanh( const double x ); From 84543b333ea88b403202b6876eba1b976d7313c5 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:23:46 +0530 Subject: [PATCH 06/10] Update main.c Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c index 316ce00c65cc..9930cec9cb4f 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c @@ -20,7 +20,6 @@ #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/assert/is_infinite.h" #include "stdlib/math/base/special/ln.h" -#include "stdlib/math/base/special/sqrt.h" #include /** From 6e67005f66205c79705a3e1ec1850386491a5c03 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:26:03 +0530 Subject: [PATCH 07/10] Update manifest.json Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../@stdlib/math/base/special/fast/atanh/manifest.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/manifest.json b/lib/node_modules/@stdlib/math/base/special/fast/atanh/manifest.json index 26ed895f38cb..3086e38c4d7e 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/manifest.json +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/manifest.json @@ -38,7 +38,6 @@ "dependencies": [ "@stdlib/math/base/napi/unary", "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/sqrt", "@stdlib/math/base/special/ln", "@stdlib/math/base/assert/is-infinite" ] @@ -55,7 +54,6 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/sqrt", "@stdlib/math/base/special/ln", "@stdlib/math/base/assert/is-infinite" ] @@ -72,7 +70,6 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/sqrt", "@stdlib/math/base/special/ln", "@stdlib/math/base/assert/is-infinite" ] From bdfbeed260a5726c1445dfa93d7b78bf0fb5fbb4 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:33:40 +0530 Subject: [PATCH 08/10] Update README.md Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- .../@stdlib/math/base/special/fast/atanh/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md index fcd67dd53b31..572a4de362e6 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md @@ -172,13 +172,13 @@ double stdlib_base_fast_atanh( const double x ); #include int main( void ) { - const double x[] = { -1.0, -0.78, -0.56, -0.33, -0.11, 0.11, 0.33, 0.56, 0.78, 1.0 }; + const double x[] = { -1.0, -0.78, -0.56, -0.33, -0.11, 0.11, 0.33, 0.56, 0.78, 1.0 }; - double v; - int i; - for ( i = 0; i < 10; i++ ) { - v = stdlib_base_fast_atanh( x[ i ] ); - printf( "atanh(%lf) = %lf\n", x[ i ], v ); + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_fast_atanh( x[ i ] ); + printf( "atanh(%lf) = %lf\n", x[ i ], v ); } } ``` From 4d3bd3799682ec9a78c14798be14bd0231e1d6e6 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Date: Sat, 16 Mar 2024 19:38:29 +0530 Subject: [PATCH 09/10] Update README.md Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> --- lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md index 572a4de362e6..b2c6fd3b0656 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/README.md @@ -179,7 +179,7 @@ int main( void ) { for ( i = 0; i < 10; i++ ) { v = stdlib_base_fast_atanh( x[ i ] ); printf( "atanh(%lf) = %lf\n", x[ i ], v ); - } + } } ``` From b007689f242a14602bf6b5724cbbfcdf40afad96 Mon Sep 17 00:00:00 2001 From: Pranav <85227306+Pranavchiku@users.noreply.github.com> Date: Sun, 17 Mar 2024 20:58:15 +0530 Subject: [PATCH 10/10] chore: apply suggestions from code review Signed-off-by: Pranav <85227306+Pranavchiku@users.noreply.github.com> --- .../@stdlib/math/base/special/fast/atanh/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c index 9930cec9cb4f..696f06571aa2 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c @@ -39,5 +39,5 @@ double stdlib_base_fast_atanh( const double x ) { if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) ) { return 0.0 / 0.0 ; // NaN } - return 0.5 * stdlib_base_ln( (1.0+x) / (1.0-x) ); + return 0.5 * stdlib_base_ln( ( 1.0 + x ) / ( 1.0 - x ) ); }