From 54c5c1bbfc9497e304bc709b6ad77566a98a92f5 Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Sun, 7 Jul 2024 21:30:54 +0530 Subject: [PATCH] feat: add C implementation for math/base/special/digamma --- .../math/base/special/digamma/README.md | 89 ++++++ .../digamma/benchmark/benchmark.native.js | 61 ++++ .../digamma/benchmark/c/native/Makefile | 146 ++++++++++ .../digamma/benchmark/c/native/benchmark.c | 136 +++++++++ .../math/base/special/digamma/binding.gyp | 170 +++++++++++ .../base/special/digamma/examples/c/Makefile | 146 ++++++++++ .../base/special/digamma/examples/c/example.c | 31 ++ .../math/base/special/digamma/include.gypi | 53 ++++ .../stdlib/math/base/special/digamma.h | 41 +++ .../math/base/special/digamma/lib/native.js | 62 ++++ .../base/special/digamma/lib/polyval_p.js | 2 +- .../base/special/digamma/lib/rational_pq.js | 4 +- .../math/base/special/digamma/manifest.json | 85 ++++++ .../base/special/digamma/scripts/evalpoly.js | 48 ++++ .../special/digamma/scripts/evalrational.js | 48 ++++ .../math/base/special/digamma/src/Makefile | 70 +++++ .../math/base/special/digamma/src/addon.c | 23 ++ .../math/base/special/digamma/src/main.c | 269 ++++++++++++++++++ .../base/special/digamma/test/test.native.js | 110 +++++++ 19 files changed, 1591 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/include/stdlib/math/base/special/digamma.h create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/digamma/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/README.md b/lib/node_modules/@stdlib/math/base/special/digamma/README.md index d43cc085409c..ab46b4a40f75 100644 --- a/lib/node_modules/@stdlib/math/base/special/digamma/README.md +++ b/lib/node_modules/@stdlib/math/base/special/digamma/README.md @@ -115,6 +115,95 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/digamma.h" +``` + +#### digamma( x ) + +Evaluates the [digamma function][digamma-function]. + +```c +double out = digamma( -2.5 ); +// returns ~1.103 + +out = digamma( 1.0 ); +// returns ~-0.577 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double digamma( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/digamma.h" +#include +#include + +int main( void ) { + const double x[] = { 4.0, -1.5, -0.5, 0.5 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_digamma( x[ i ] ); + printf( "digamma(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/digamma/benchmark/benchmark.native.js new file mode 100644 index 000000000000..9fe3cde0fe6d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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 EPS = require( '@stdlib/constants/float64/eps' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var digamma = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( digamma 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() * 1000.0 ) + EPS; + y = digamma( x ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/digamma/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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/digamma/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/digamma/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..153a9508743b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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 `digamma`. +*/ +#include "stdlib/math/base/special/digamma.h" +#include +#include +#include +#include +#include + +#define NAME "digamma" +#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 = ( 1000.0 * rand_double() ) + 0.1; + y = stdlib_base_digamma( 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/digamma/binding.gyp b/lib/node_modules/@stdlib/math/base/special/digamma/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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/digamma/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/digamma/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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/digamma/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/digamma/examples/c/example.c new file mode 100644 index 000000000000..6b8aa919dbf6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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/digamma.h" +#include + +int main( void ) { + const double x[] = { 4.0, -1.5, -0.5, 0.5 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_digamma( x[ i ] ); + printf( "digamma(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/include.gypi b/lib/node_modules/@stdlib/math/base/special/digamma/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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': [ + '--> +* +* Note that, since \\(\mathrm{root}\\) is irrational, we need twice as many digits in \\(\mathrm{root}\\) as in \\(x\\) in order to avoid cancellation error during subtraction, assuming \\(x\\) has an exact value. This means that, even if \\(x\\) is rounded to the next representable value, the result of \\(\psi(x)\\) will not be zero. +* +* +* +* +* +* This approach gives 17-digit precision. +* +* +* +* 4. For \\(x \in \[2,\mathrm{BIG}]\\), we use the recurrence relation +* +* ```tex +* \psi(x+1) = \psi(x) + \frac{1}{x} +* ``` +* +* to shift the evaluation range to \\(\[1,2]\\). +* +* 5. For \\(x > \mathrm{BIG}\\), we use the asymptotic expression +* +* ```tex +* \psi(x) = \ln(x) + \frac{1}{2x} - \biggl( \frac{B_{21}}{2x^2} + \frac{B_{22}}{4x^4} + \frac{B_{23}}{6x^6} + \ldots \biggr) +* ``` +* +* This expansion, however, is divergent after a few terms. The number of terms depends on \\(x\\). Accordingly, we must choose a value of \\(\mathrm{BIG}\\) which allows us to truncate the series at a term that is too small to have an effect on the result. Setting \\(\mathrm{BIG} = 10\\), allows us to truncate the series early and evaluate as \\(1/x^2\\). +* +* +* +* This approach gives 17-digit precision for \\(x \geq 10\\). +* +* +* +* ## Notes +* +* - Maximum deviation found: \\(1.466\\mbox{e-}18\\) +* - Max error found: \\(2.452\mbox{e-}17\\) (double precision) +* +* @param x input value +* @returns function value +* +* @example +* double v = stdlib_base_digamma( -2.5 ); +* // returns ~1.103 +*/ +double stdlib_base_digamma( const double x ) { + double rem; + double tmp; + double xc; + + if ( stdlib_base_is_nan( x ) || x == 0.0 ) { + return 0.0 / 0.0; // NaN + } + + // If `x` is negative, use reflection... + xc = x; + if ( xc <= -1.0 ) { + // Reflect: + xc = 1.0 - xc; + + // Argument reduction for tan: + rem = xc - stdlib_base_floor( xc ); + + // Shift to negative if > 0.5: + if ( rem > 0.5 ) { + rem -= 1.0; + } + + // Check for evaluation at a negative pole: + if ( rem == 0.0 ) { + return 0.0 / 0.0; // NaN + } + tmp = STDLIB_CONSTANT_FLOAT64_PI / stdlib_base_tan( STDLIB_CONSTANT_FLOAT64_PI * rem ); + } else { + tmp = 0.0; + } + + // If we're above the lower-limit for the asymptotic expansion, then use it... + if ( xc >= MIN_SAFE_ASYMPTOTIC ) { + tmp += asymptoticApprox( xc ); + return tmp; + } + + // If x > 2, reduce to the interval [1,2]... + while ( xc > 2.0 ) { + xc -= 1.0; + tmp += 1.0 / xc; + } + + // If x < 1, use recurrence to shift to > 1.. + while ( xc < 1.0 ) { + tmp -= 1.0 / xc; + xc += 1.0; + } + tmp += rationalApprox( xc ); + return tmp; +} diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/digamma/test/test.native.js new file mode 100644 index 000000000000..f7d0c06157f3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/digamma/test/test.native.js @@ -0,0 +1,110 @@ +/** +* @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 isfinite = require( '@stdlib/math/base/assert/is-finite' ); +var isnan = require( '@stdlib/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var digamma = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( digamma instanceof Error ) +}; + + +// FIXTURES // + +var data = require( './fixtures/r/data.json' ); +var expected = require( './fixtures/r/expected.json' ); +var v; +var i; +for ( i = 0; i < expected.length; i++ ) { + v = expected[ i ]; + if ( v === 'Inf' ) { + expected[ i ] = PINF; + } + else if ( v === 'NaN' ) { + expected[ i ] = NaN; + } +} + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof digamma, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', opts, function test( t ) { + var val = digamma( NaN ); + t.equal( isnan( val ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `0`', opts, function test( t ) { + var val = digamma( 0.0 ); + t.equal( isnan( val ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function evaluates the digamma function', opts, function test( t ) { + var actual; + var b1; + var b2; + var i; + for ( i = 0; i < data.length; i++ ) { + actual = digamma( data[ i ] ); + + b1 = isfinite( actual ); + b2 = isfinite( expected[ i ] ); + t.equal( b1, b2, 'returned result is ' + ( (b2) ? 'finite' : 'not finite' ) ); + + b1 = isnan( actual ); + b2 = isnan( expected[ i ] ); + t.equal( b1, b2, 'returned result is ' + ( (b1) ? '' : 'not' ) + ' NaN' ); + if ( !b1 ) { + t.ok( abs( actual - expected[ i ] ) < 1.0e-14, 'returned result is within tolerance. actual: ' + actual + '; expected: ' + expected[ i ] + '.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the digamma function for `x` such that remainder > 0.5', opts, function test( t ) { + var expected; + var actual; + var x; + + x = -3.8; + expected = -2.863183589156929; + actual = digamma( x ); + + t.ok( abs( actual - expected ) < 1.0e-14, 'returned result within tolerance' ); + t.end(); +});