diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md index 6598538c881e..fa72b8c599ad 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md @@ -72,7 +72,7 @@ var eta = require( '@stdlib/math/base/special/dirichlet-eta' ); #### eta( s ) -Evaluates the [Dirichlet eta][eta-function] function as a function of a real variable `s`. +Evaluates the Dirichlet eta function for a double-precision floating-point number `s`. ```javascript var v = eta( 0.0 ); // Abel sum of 1-1+1-1+... @@ -117,6 +117,91 @@ for ( i = 0; i < s.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/dirichlet_eta.h" +``` + +#### stdlib_base_eta( s ) + +Evaluates the Dirichlet eta function for a double-precision floating-point number `s`. + +```c +double y = stdlib_base_eta( 0.0 ); +// returns 0.5 +``` + +The function accepts the following arguments: + +- **s**: `[in] double` input value. + +```c +double stdlib_base_eta( const double s ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/dirichlet_eta.h" +#include + +int main( void ) { + const double x[] = { 45.0, 90.0, 0.0, 0.0 / 0.0 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_eta( x[ i ] ); + printf( "η(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.js index 653b8f26a4bc..1348ce002bb0 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.js @@ -21,7 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var randu = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var eta = require( './../lib' ); @@ -34,10 +34,11 @@ bench( pkg, function benchmark( b ) { var y; var i; + x = randu( 100, -500.0, 500.0 ); + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*1000.0 ) - 500.0; - y = eta( x ); + y = eta( x[ i % x.length ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/benchmark.native.js new file mode 100644 index 000000000000..ac3b3b15a92e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var eta = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( eta instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -500.0, 500.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = eta( x[ i % x.length ] ); + 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/dirichlet-eta/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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/dirichlet-eta/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..4df2552b7208 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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. +*/ + +#include "stdlib/math/base/special/dirichlet_eta.h" +#include +#include +#include +#include +#include + +#define NAME "eta" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double x[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = ( 1000.0 * rand_double() ) - 500.0; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_eta( x[ i % 100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/binding.gyp b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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/dirichlet-eta/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/repl.txt index f0238171d325..497f4e9bdc95 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/repl.txt @@ -1,6 +1,7 @@ {{alias}}( s ) - Evaluates the Dirichlet eta function as a function of a real variable `s`. + Evaluates the Dirichlet eta function for a double-precision + floating-point number `s`. Parameters ---------- diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/types/index.d.ts index 317cdd8b8a69..441c6deb1bb1 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the Dirichlet eta function. +* Evaluates the Dirichlet eta function for a double-precision floating-point number `s`. * * @param s - input value * @returns function value diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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/dirichlet-eta/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/c/example.c new file mode 100644 index 000000000000..78c684679ecf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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/dirichlet_eta.h" +#include + +int main( void ) { + const double x[] = { 45.0, 90.0, 0.0, 0.0 / 0.0 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_eta( x[ i ] ); + printf( "η(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/include.gypi b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/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': [ + ' ln(2) +* // returns ~0.6931 +* +* @example +* var v = eta( 3.14 ); +* // returns ~0.9096 +* +* @example +* var v = eta( NaN ); +* // returns NaN +*/ +function eta( s ) { + return addon( s ); +} + + +// EXPORTS // + +module.exports = eta; diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/manifest.json b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/manifest.json new file mode 100644 index 000000000000..629c9eb58123 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/manifest.json @@ -0,0 +1,81 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/unary", + "@stdlib/math/base/special/powm1", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/riemann-zeta", + "@stdlib/constants/float64/ln-two" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/powm1", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/riemann-zeta", + "@stdlib/constants/float64/ln-two" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/powm1", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/riemann-zeta", + "@stdlib/constants/float64/ln-two" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/package.json b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/package.json index 1debb4ae4b12..2421a2d10b0e 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/package.json +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/package.json @@ -14,11 +14,14 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", "example": "./examples", + "include": "./include", "lib": "./lib", + "src": "./src", "test": "./test" }, "types": "./docs/types", diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/Makefile b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/addon.c b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/addon.c new file mode 100644 index 000000000000..a85f93d22450 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/dirichlet_eta.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_eta ) diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/main.c b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/main.c new file mode 100644 index 000000000000..22fbf425edbf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/src/main.c @@ -0,0 +1,44 @@ +/** +* @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/dirichlet_eta.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/special/powm1.h" +#include "stdlib/constants/float64/ln_two.h" +#include "stdlib/math/base/special/riemann_zeta.h" + +/** +* Evaluates the Dirichlet eta function for a double-precision floating-point number `s`. +* +* @param s input value +* @return function value +* +* @example +* double y = stdlib_base_eta( 0.0 ); +* // returns 0.5 +*/ +double stdlib_base_eta( const double s ) { + if ( stdlib_base_is_nan( s ) ) { + return 0.0 / 0.0; // NaN + } + if ( s == 1.0 ) { + // Alternating harmonic series... + return STDLIB_CONSTANT_FLOAT64_LN2; + } + return -stdlib_base_powm1( 2.0, 1.0 - s ) * stdlib_base_zeta( s ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.js b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.js index e5098cdf7bf8..e0b39122979e 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.js @@ -45,7 +45,7 @@ tape( 'main export is a function', function test( t ) { tape( 'if provided `NaN`, the function returns `NaN`', function test( t ) { var v = eta( NaN ); - t.equal( isnan( v ), true, 'returns NaN when provided a NaN' ); + t.equal( isnan( v ), true, 'returns expected value when provided a NaN' ); t.end(); }); @@ -64,8 +64,8 @@ tape( 'the function evaluates the Dirichlet eta function', function test( t ) { delta = abs( v - expected[i] ); // R: 1.1e5*eps => 2.4424906541753444e-11 => http://finzi.psych.upenn.edu/library/pracma/html/eta.html states that accuracy is 13 digits - // Julia: 102*eps => 2.2648549702353193e-14 - tol = 102.0 * EPS * abs( expected[i] ); + // Julia: 68.0*eps => 1.509903313490213e-14 + tol = 68.0 * EPS * abs( expected[i] ); t.ok( delta <= tol, 'within tolerance. s: '+s[i]+'. v: '+v+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' ); } t.end(); @@ -73,19 +73,19 @@ tape( 'the function evaluates the Dirichlet eta function', function test( t ) { tape( 'if provided `1`, the function returns `ln(2)` (alternating harmonic series)', function test( t ) { var v = eta( 1.0 ); - t.equal( v, LN2, 'returns ln(2)' ); + t.equal( v, LN2, 'returns expected value' ); t.end(); }); tape( 'if provided `0`, the function returns `0.5` (Abel sum)', function test( t ) { var v = eta( 0.0 ); - t.equal( v, 0.5, 'returns 0.5' ); + t.equal( v, 0.5, 'returns expected value' ); t.end(); }); tape( 'if provided `-1`, the function returns `0.25` (Abel sum)', function test( t ) { var v = eta( -1.0 ); - t.equal( v, 0.25, 'returns 0.25' ); + t.equal( v, 0.25, 'returns expected value' ); t.end(); }); @@ -179,7 +179,7 @@ tape( 'if provided `10`, the function returns `73π**10/6842880`', function test v = eta( s ); delta = abs( v - expected ); - tol = EPS * 1.55 * abs( expected ); + tol = 1.55 * EPS * abs( expected ); t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); t.end(); diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.native.js new file mode 100644 index 000000000000..f82544cbd156 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/test/test.native.js @@ -0,0 +1,214 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var LN2 = require( '@stdlib/constants/float64/ln-two' ); +var PI = require( '@stdlib/constants/float64/pi' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var eta = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( eta instanceof Error ) +}; + + +// FIXTURES // + +var data = require( './fixtures/julia/results.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof eta, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t ) { + var v = eta( NaN ); + t.equal( isnan( v ), true, 'returns expected value when provided a NaN' ); + t.end(); +}); + +tape( 'the function evaluates the Dirichlet eta function', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + var i; + + s = data.x; + expected = data.expected; + for ( i = 0; i < s.length; i++ ) { + v = eta( s[i] ); + delta = abs( v - expected[i] ); + + // R: 1.1e5*eps => 2.4424906541753444e-11 => http://finzi.psych.upenn.edu/library/pracma/html/eta.html states that accuracy is 13 digits + // Julia: 68.0*eps => 1.509903313490213e-14 + tol = 68.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. s: '+s[i]+'. v: '+v+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + t.end(); +}); + +tape( 'if provided `1`, the function returns `ln(2)` (alternating harmonic series)', opts, function test( t ) { + var v = eta( 1.0 ); + t.equal( v, LN2, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided `0`, the function returns `0.5` (Abel sum)', opts, function test( t ) { + var v = eta( 0.0 ); + t.equal( v, 0.5, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided `-1`, the function returns `0.25` (Abel sum)', opts, function test( t ) { + var v = eta( -1.0 ); + t.equal( v, 0.25, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided `2`, the function returns `π²/12`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + // https://oeis.org/A072691 + expected = 0.822467033424113218236207583323012594609474950603399218867779114685003735201600436916814450309879352652002; // eslint-disable-line max-len + + s = 2.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +}); + +tape( 'if provided `4`, the function returns `7π**4/720`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + expected = 7.0 * pow( PI, 4 ) / 720.0; + + s = 4.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +}); + +tape( 'if provided `6`, the function returns `31π**6/30240`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + expected = 31.0 * pow( PI, 6 ) / 30240.0; + + s = 6.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = 2.0 * EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +}); + +tape( 'if provided `8`, the function returns `127π**8/1209600`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + expected = 127.0 * pow( PI, 8 ) / 1209600.0; + + s = 8.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = 2.05 * EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +}); + +tape( 'if provided `10`, the function returns `73π**10/6842880`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + expected = 73.0 * pow( PI, 10 ) / 6842880.0; + + s = 10.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = 1.55 * EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +}); + +tape( 'if provided `12`, the function returns `1414477π**12/1307674368000`', opts, function test( t ) { + var expected; + var delta; + var tol; + var s; + var v; + + expected = 1414477.0 * pow( PI, 12 ) / 1307674368000.0; + + s = 12.0; + v = eta( s ); + + delta = abs( v - expected ); + tol = 2.05 * EPS * abs( expected ); + + t.ok( delta <= tol, 'within tolerance. s: '+s+'. v: '+v+'. E: '+expected+' Δ: '+delta+'. tol: '+tol ); + t.end(); +});