From 843ca9a8fc452e4d2287abe8b5c97aab7706f7e1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 14 Mar 2024 02:26:55 +0000 Subject: [PATCH] Auto-generated commit --- CONTRIBUTORS | 28 +-- LICENSE | 71 +++---- base/special/bernoulli/README.md | 88 +++++++++ .../bernoulli/benchmark/benchmark.native.js | 61 ++++++ .../bernoulli/benchmark/c/native/Makefile | 146 ++++++++++++++ .../bernoulli/benchmark/c/native/benchmark.c | 136 +++++++++++++ base/special/bernoulli/binding.gyp | 170 ++++++++++++++++ base/special/bernoulli/examples/c/Makefile | 146 ++++++++++++++ base/special/bernoulli/examples/c/example.c | 30 +++ base/special/bernoulli/include.gypi | 53 +++++ .../stdlib/math/base/special/bernoulli.h | 40 ++++ base/special/bernoulli/lib/native.js | 77 ++++++++ base/special/bernoulli/manifest.json | 84 ++++++++ base/special/bernoulli/src/Makefile | 70 +++++++ base/special/bernoulli/src/addon.c | 23 +++ base/special/bernoulli/src/main.c | 183 ++++++++++++++++++ base/special/bernoulli/test/test.native.js | 99 ++++++++++ base/special/csch/README.md | 4 +- 18 files changed, 1459 insertions(+), 50 deletions(-) create mode 100644 base/special/bernoulli/benchmark/benchmark.native.js create mode 100644 base/special/bernoulli/benchmark/c/native/Makefile create mode 100644 base/special/bernoulli/benchmark/c/native/benchmark.c create mode 100644 base/special/bernoulli/binding.gyp create mode 100644 base/special/bernoulli/examples/c/Makefile create mode 100644 base/special/bernoulli/examples/c/example.c create mode 100644 base/special/bernoulli/include.gypi create mode 100644 base/special/bernoulli/include/stdlib/math/base/special/bernoulli.h create mode 100644 base/special/bernoulli/lib/native.js create mode 100644 base/special/bernoulli/manifest.json create mode 100644 base/special/bernoulli/src/Makefile create mode 100644 base/special/bernoulli/src/addon.c create mode 100644 base/special/bernoulli/src/main.c create mode 100644 base/special/bernoulli/test/test.native.js diff --git a/CONTRIBUTORS b/CONTRIBUTORS index eed6b3c75..554fdde95 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -2,17 +2,17 @@ # # Contributors listed in alphabetical order. -Adarsh Palaskar <83298237+adarshpalaskar1@users.noreply.github.com> -Aditya Sapra <110766802+adityacodes30@users.noreply.github.com> +Adarsh Palaskar +Aditya Sapra AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com> Ali Salesi -Aman Bhansali <92033532+aman-095@users.noreply.github.com> +Aman Bhansali Amit Jimiwal -Anudeep Sanapala <71971574+anudeeps0306@users.noreply.github.com> +Anudeep Sanapala Athan Reines Brendan Graetz Bruno Fenzl -Chinmay J <86140365+JawHawk@users.noreply.github.com> +Chinmay Joshi <86140365+JawHawk@users.noreply.github.com> Christopher Dambamuromo Dan Rose Daniel Killenberger @@ -20,8 +20,8 @@ Dominik Moritz Dorrin Sotoudeh EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com> Frank Kovacs -GUNJ JOSHI -Golden <103646877+AuenKr@users.noreply.github.com> +Golden Kumar <103646877+AuenKr@users.noreply.github.com> +Gunj Joshi Harshita Kalani Jaimin Godhani <112328542+Jai0401@users.noreply.github.com> James Gelok @@ -50,7 +50,7 @@ Pranav Goswami Praneki <97080887+PraneGIT@users.noreply.github.com> Pratik <97464067+Pratik772846@users.noreply.github.com> Priyansh <88396544+itsspriyansh@users.noreply.github.com> -Raunak Kumar Gupta <95216822+raunak-dev-edu@users.noreply.github.com> +Raunak Kumar Gupta Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Ricky Reusser Robert Gislason @@ -59,16 +59,16 @@ Rutam <138517416+performant23@users.noreply.github.com> Ryan Seal Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com> Seyyed Parsa Neshaei -Shashank Shekhar Singh <123410790+Shashankss1205@users.noreply.github.com> +Shashank Shekhar Singh Shraddheya Shendre -Shubham +Shubham Mishra Snehil Shah <130062020+Snehil-Shah@users.noreply.github.com> -Spandan Barve <114365550+marsian83@users.noreply.github.com> +Spandan Barve Stephannie Jiménez Gacha -Utkarsh <137638507+Ut-the-pro@users.noreply.github.com> +Utkarsh +Utkarsh Raj +Varad Gupta Yernar Yergaziyev nishant-s7 <97207366+nishant-s7@users.noreply.github.com> orimiles5 <97595296+orimiles5@users.noreply.github.com> rei2hu -utkarsh_raj <49344502+rajutkarsh07@users.noreply.github.com> -vr-varad <114755221+vr-varad@users.noreply.github.com> diff --git a/LICENSE b/LICENSE index 5965a0b2c..d1534e6cb 100644 --- a/LICENSE +++ b/LICENSE @@ -207,6 +207,28 @@ FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* Cephes + +Copyright (c) 1984-2000 Stephen L. Moshier + +Some software in this archive may be from the book _Methods and Programs for +Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) +or from the Cephes Mathematical Library, a commercial product. In either event, +it is copyrighted by the author. What you see here may be used freely but it +comes with no support or guarantee. + +Stephen L. Moshier +moshier@na-net.ornl.gov + +* FreeBSD + +Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. + +Developed at SunPro, a Sun Microsystems, Inc. business. +Permission to use, copy, modify, and distribute this +software is freely granted, provided that this notice +is preserved. + * Go Copyright (c) 2009 The Go Authors. All rights reserved. @@ -237,28 +259,6 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -* Cephes - -Copyright (c) 1984-2000 Stephen L. Moshier - -Some software in this archive may be from the book _Methods and Programs for -Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) -or from the Cephes Mathematical Library, a commercial product. In either event, -it is copyrighted by the author. What you see here may be used freely but it -comes with no support or guarantee. - -Stephen L. Moshier -moshier@na-net.ornl.gov - -* FreeBSD - -Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. - -Developed at SunPro, a Sun Microsystems, Inc. business. -Permission to use, copy, modify, and distribute this -software is freely granted, provided that this notice -is preserved. - * Faddeeva Copyright (c) 2012 Massachusetts Institute of Technology @@ -282,18 +282,13 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* SLATEC Common Mathematical Library - -Public domain. - -* FDLIBM - -Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved. - -Developed at SunPro, a Sun Microsystems, Inc. business. -Permission to use, copy, modify, and distribute this -software is freely granted, provided that this notice -is preserved. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -325,3 +320,11 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* SLATEC Common Mathematical Library + +Public domain. + +* FDLIBM + +Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved. + diff --git a/base/special/bernoulli/README.md b/base/special/bernoulli/README.md index e747d3b7c..d1d53aff7 100644 --- a/base/special/bernoulli/README.md +++ b/base/special/bernoulli/README.md @@ -123,6 +123,94 @@ for ( i = 0; i < 280; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/bernoulli.h" +``` + +#### stdlib_base_bernoulli( n ) + +Computes the nth [Bernoulli number][bernoulli-number]. + +```c +double out = stdlib_base_bernoulli( 0 ); +// returns 1.0 + +out = stdlib_base_bernoulli( 1 ); +// returns 0.0 +``` + +The function accepts the following arguments: + +- **n**: `[in] int32_t` input value. + +```c +double stdlib_base_bernoulli( const int32_t n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/bernoulli.h" +#include +#include + +int main( void ) { + int32_t i; + double v; + + for ( i = 0; i < 130; i++ ) { + v = stdlib_base_bernoulli( i ); + printf( "bernoulli(%d) = %lf\n", i, v ); + } +} +``` + +
+ + + +
+ + +
diff --git a/base/special/bernoulli/benchmark/benchmark.native.js b/base/special/bernoulli/benchmark/benchmark.native.js new file mode 100644 index 000000000..36803379d --- /dev/null +++ b/base/special/bernoulli/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 floor = require( './../../../../base/special/floor' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var bernoulli = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( bernoulli 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 = floor( randu() * 500.0 ); + y = bernoulli( 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/base/special/bernoulli/benchmark/c/native/Makefile b/base/special/bernoulli/benchmark/c/native/Makefile new file mode 100644 index 000000000..f69e9da2b --- /dev/null +++ b/base/special/bernoulli/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/base/special/bernoulli/benchmark/c/native/benchmark.c b/base/special/bernoulli/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..f9fa03950 --- /dev/null +++ b/base/special/bernoulli/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 `bernoulli`. +*/ +#include "stdlib/math/base/special/bernoulli.h" +#include +#include +#include +#include +#include + +#define NAME "bernoulli" +#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 = ( 500.0 * rand_double() ); + y = stdlib_base_bernoulli( 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/base/special/bernoulli/binding.gyp b/base/special/bernoulli/binding.gyp new file mode 100644 index 000000000..ec3992233 --- /dev/null +++ b/base/special/bernoulli/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/base/special/bernoulli/examples/c/Makefile b/base/special/bernoulli/examples/c/Makefile new file mode 100644 index 000000000..6aed70daf --- /dev/null +++ b/base/special/bernoulli/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/base/special/bernoulli/examples/c/example.c b/base/special/bernoulli/examples/c/example.c new file mode 100644 index 000000000..c07123fe6 --- /dev/null +++ b/base/special/bernoulli/examples/c/example.c @@ -0,0 +1,30 @@ +/** +* @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/bernoulli.h" +#include + +int main( void ) { + int32_t i; + double v; + + for ( i = 0; i < 130; i++ ) { + v = stdlib_base_bernoulli( i ); + printf( "bernoulli(%d) = %lf\n", i, v ); + } +} diff --git a/base/special/bernoulli/include.gypi b/base/special/bernoulli/include.gypi new file mode 100644 index 000000000..575cb043c --- /dev/null +++ b/base/special/bernoulli/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': [ + ' + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Computes the nth Bernoulli number. +*/ +double stdlib_base_bernoulli( const int32_t n ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_BERNOULLI_H diff --git a/base/special/bernoulli/lib/native.js b/base/special/bernoulli/lib/native.js new file mode 100644 index 000000000..08d220eb7 --- /dev/null +++ b/base/special/bernoulli/lib/native.js @@ -0,0 +1,77 @@ +/** +* @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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the nth Bernoulli number. +* +* @param {NonNegativeInteger} n - the Bernoulli number to compute +* @returns {number} Bernoulli number +* +* @example +* var y = bernoulli( 0 ); +* // returns 1.0 +* +* @example +* var y = bernoulli( 1 ); +* // returns 0.0 +* +* @example +* var y = bernoulli( 2 ); +* // returns ~0.167 +* +* @example +* var y = bernoulli( 3 ); +* // returns 0.0 +* +* @example +* var y = bernoulli( 4 ); +* // returns ~-0.033 +* +* @example +* var y = bernoulli( 5 ); +* // returns 0.0 +* +* @example +* var y = bernoulli( 20 ); +* // returns ~-529.124 +* +* @example +* var y = bernoulli( 260 ); +* // returns -Infinity +* +* @example +* var y = bernoulli( 262 ); +* // returns Infinity +*/ +function bernoulli( n ) { + return addon( n ); +} + + +// EXPORTS // + +module.exports = bernoulli; diff --git a/base/special/bernoulli/manifest.json b/base/special/bernoulli/manifest.json new file mode 100644 index 000000000..0c12d1f3c --- /dev/null +++ b/base/special/bernoulli/manifest.json @@ -0,0 +1,84 @@ +{ + "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/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/ninf", + "@stdlib/constants/float64/pinf" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/ninf", + "@stdlib/constants/float64/pinf" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/ninf", + "@stdlib/constants/float64/pinf" + ] + } + ] +} diff --git a/base/special/bernoulli/src/Makefile b/base/special/bernoulli/src/Makefile new file mode 100644 index 000000000..bcf18aa46 --- /dev/null +++ b/base/special/bernoulli/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/base/special/bernoulli/src/addon.c b/base/special/bernoulli/src/addon.c new file mode 100644 index 000000000..2f32b932f --- /dev/null +++ b/base/special/bernoulli/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/bernoulli.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_I_D( stdlib_base_bernoulli ) diff --git a/base/special/bernoulli/src/main.c b/base/special/bernoulli/src/main.c new file mode 100644 index 000000000..22e851dcc --- /dev/null +++ b/base/special/bernoulli/src/main.c @@ -0,0 +1,183 @@ +/** +* @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/assert/is_nonnegative_integer.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/assert/is_odd.h" +#include "stdlib/constants/float64/ninf.h" +#include "stdlib/constants/float64/pinf.h" +#include "stdlib/math/base/special/bernoulli.h" + +static const double bernoulli_value[ 130 ] = { + 1.00000000000000000000000000000000000000000, + 0.166666666666666666666666666666666666666667, + -0.0333333333333333333333333333333333333333333, + 0.0238095238095238095238095238095238095238095, + -0.0333333333333333333333333333333333333333333, + 0.0757575757575757575757575757575757575757576, + -0.253113553113553113553113553113553113553114, + 1.16666666666666666666666666666666666666667, + -7.09215686274509803921568627450980392156863, + 54.9711779448621553884711779448621553884712, + -529.124242424242424242424242424242424242424, + 6192.12318840579710144927536231884057971014, + -86580.2531135531135531135531135531135531136, + 1.42551716666666666666666666666666666666667e6, + -2.72982310678160919540229885057471264367816e7, + 6.01580873900642368384303868174835916771401e8, + -1.51163157670921568627450980392156862745098e10, + 4.29614643061166666666666666666666666666667e11, + -1.37116552050883327721590879485616327721591e13, + 4.88332318973593166666666666666666666666667e14, + -1.92965793419400681486326681448632668144863e16, + 8.41693047573682615000553709856035437430786e17, + -4.03380718540594554130768115942028985507246e19, + 2.11507486380819916056014539007092198581560e21, + -1.20866265222965259346027311937082525317819e23, + 7.50086674607696436685572007575757575757576e24, + -5.03877810148106891413789303052201257861635e26, + 3.65287764848181233351104308429711779448622e28, + -2.84987693024508822262691464329106781609195e30, + 2.38654274996836276446459819192192149717514e32, + -2.13999492572253336658107447651910973926742e34, + 2.05009757234780975699217330956723102516667e36, + -2.09380059113463784090951852900279701847092e38, + 2.27526964884635155596492603527692645814700e40, + -2.62577102862395760473030497361582020814490e42, + 3.21250821027180325182047923042649852435219e44, + -4.15982781667947109139170744952623589366896e46, + 5.69206954820352800238834562191210586444805e48, + -8.21836294197845756922906534686173330145509e50, + 1.25029043271669930167323398297028955241772e53, + -2.00155832332483702749253291988132987687242e55, + 3.36749829153643742333966769033387530162196e57, + -5.94709705031354477186604968440515408405791e59, + 1.10119103236279775595641307904376916046305e62, + -2.13552595452535011886583850190410656789733e64, + 4.33288969866411924196166130593792062184514e66, + -9.18855282416693282262005552155018971389604e68, + 2.03468967763290744934550279902200200659751e71, + -4.70038339580357310785752555350060606545967e73, + 1.13180434454842492706751862577339342678904e76, + -2.83822495706937069592641563364817647382847e78, + 7.40642489796788506297508271409209841768797e80, + -2.00964548027566044834656196727153631868673e83, + 5.66571700508059414457193460305193569614195e85, + -1.65845111541362169158237133743199123014950e88, + 5.03688599504923774192894219151801548124424e90, + -1.58614682376581863693634015729664387827410e93, + 5.17567436175456269840732406825071225612408e95, + -1.74889218402171173396900258776181591451415e98, + 6.11605199949521852558245252642641677807677e100, + -2.21227769127078349422883234567129324455732e103, + 8.27227767987709698542210624599845957312047e105, + -3.19589251114157095835916343691808148735263e108, + 1.27500822233877929823100243029266798669572e111, + -5.25009230867741338994028246245651754469199e113, + 2.23018178942416252098692981988387281437383e116, + -9.76845219309552044386335133989802393011669e118, + 4.40983619784529542722726228748131691918758e121, + -2.05085708864640888397293377275830154864566e124, + 9.82144332797912771075729696020975210414919e126, + -4.84126007982088805087891967099634127611305e129, + 2.45530888014809826097834674040886903996737e132, + -1.28069268040847475487825132786017857218118e135, + 6.86761671046685811921018885984644004360924e137, + -3.78464685819691046949789954163795568144895e140, + 2.14261012506652915508713231351482720966602e143, + -1.24567271371836950070196429616376072194583e146, + 7.43457875510001525436796683940520613117807e148, + -4.55357953046417048940633332233212748767721e151, + 2.86121128168588683453638472510172325229190e154, + -1.84377235520338697276882026536287854875414e157, + 1.21811545362210466995013165065995213558174e160, + -8.24821871853141215484818457296893447301419e162, + 5.72258779378329433296516498142978615918685e165, + -4.06685305250591047267679693831158655602196e168, + 2.95960920646420500628752695815851870426379e171, + -2.20495225651894575090311752273445984836379e174, + 1.68125970728895998058311525151360665754464e177, + -1.31167362135569576486452806355817153004431e180, + 1.04678940094780380821832853929823089643829e183, + -8.54328935788337077185982546299082774593270e185, + 7.12878213224865423522884066771438224721245e188, + -6.08029314555358993000847118686477458461988e191, + 5.29967764248499239300942910043247266228490e194, + -4.71942591687458626443646229013379911103761e197, + 4.29284137914029810894168296541074669045521e200, + -3.98767449682322074434477655542938795106651e203, + 3.78197804193588827138944181161393327898220e206, + -3.66142336836811912436858082151197348755196e209, + 3.61760902723728623488554609298914089477541e212, + -3.64707726451913543621383088655499449048682e215, + 3.75087554364544090983452410104814189306842e218, + -3.93458672964390282694891288533713429355657e221, + 4.20882111481900820046571171111494898242731e224, + -4.59022962206179186559802940573325591059371e227, + 5.10317257726295759279198185106496768539760e230, + -5.78227623036569554015377271242917142512200e233, + 6.67624821678358810322637794412809363451080e236, + -7.85353076444504163225916259639312444428230e239, + 9.41068940670587255245443288258762485293948e242, + -1.14849338734651839938498599206805592548354e246, + 1.42729587428487856771416320087122499897180e249, + -1.80595595869093090142285728117654560926719e252, + 2.32615353076608052161297985184708876161736e255, + -3.04957517154995947681942819261542593785327e258, + 4.06858060764339734424012124124937318633684e261, + -5.52310313219743616252320044093186392324280e264, + 7.62772793964343924869949690204961215533859e267, + -1.07155711196978863132793524001065396932667e271, + 1.53102008959691884453440916153355334355847e274, + -2.22448916821798346676602348865048510824835e277, + 3.28626791906901391668189736436895275365183e280, + -4.93559289559603449020711938191575963496999e283, + 7.53495712008325067212266049779283956727824e286, + -1.16914851545841777278088924731655041783900e290, + 1.84352614678389394126646201597702232396492e293, + -2.95368261729680829728014917350525183485207e296, + 4.80793212775015697668878704043264072227967e299, + -7.95021250458852528538243631671158693036798e302, + 1.33527841873546338750122832017820518292039e306 +}; + + +int32_t MAX_BERNOULLI = 258; + +/** +* Computes the nth Bernoulli number. +* +* @param n input value +* @returns output value +* +* @example +* double out = stdlib_base_bernoulli( 0 ); +* // returns 1 +*/ +double stdlib_base_bernoulli( const int32_t n ) { + if ( stdlib_base_is_nan( n ) || !stdlib_base_is_nonnegative_integer( n ) ) { + return 0.0 / 0.0; // NaN + } + if ( stdlib_base_is_odd( n ) ) { + return 0.0; + } + if ( n > MAX_BERNOULLI ) { + return ( ( n / 2 ) & 1 ) ? STDLIB_CONSTANT_FLOAT64_PINF : STDLIB_CONSTANT_FLOAT64_NINF; + } + return bernoulli_value[ n / 2 ]; +} diff --git a/base/special/bernoulli/test/test.native.js b/base/special/bernoulli/test/test.native.js new file mode 100644 index 000000000..e39e1c518 --- /dev/null +++ b/base/special/bernoulli/test/test.native.js @@ -0,0 +1,99 @@ +/** +* @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( './../../../../base/assert/is-nan' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var bernoulli = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( bernoulli instanceof Error ) +}; + + +// FIXTURES // + +var BERNOULLI = require( './../lib/bernoulli.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof bernoulli, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided a negative number, the function returns `NaN`', opts, function test( t ) { + var v; + var i; + + t.strictEqual( isnan( bernoulli( -3.14 ) ), true, 'returns NaN' ); + + for ( i = -1; i > -100; i-- ) { + v = bernoulli( i ); + t.strictEqual( isnan( v ), true, 'returns NaN when provided ' + i ); + } + t.end(); +}); + +tape( 'the function returns the nth Bernoulli number for odd numbers', opts, function test( t ) { + var v; + var i; + for ( i = 1; i < 500; i += 2 ) { + v = bernoulli( i ); + + // Odd Bernoulli numbers are equal to zero: + t.strictEqual( v, 0.0, 'returns the '+i+'th Bernoulli number' ); + } + t.end(); +}); + +tape( 'the function returns the nth Bernoulli number for even numbers', opts, function test( t ) { + var v; + var i; + for ( i = 0; i < 260; i += 2 ) { + v = bernoulli( i ); + t.strictEqual( v, BERNOULLI[ i/2 ], 'returns the '+i+'th Bernoulli number' ); + } + t.end(); +}); + +tape( 'the function returns +/- infinity for large integers', opts, function test( t ) { + var v; + var i; + for ( i = 260; i < 1000; i += 2 ) { + v = bernoulli( i ); + if ( i % 4 === 0 ) { + t.strictEqual( v, NINF, 'returns negative infinity' ); + } else { + t.strictEqual( v, PINF, 'returns positive infinity' ); + } + } + t.end(); +}); diff --git a/base/special/csch/README.md b/base/special/csch/README.md index e42f72019..aceed0690 100644 --- a/base/special/csch/README.md +++ b/base/special/csch/README.md @@ -171,7 +171,7 @@ int main( void ) { ## See Also - [`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]: compute the hyperbolic arccosecant of a number. -- [`@stdlib/math/base/special/csch`][@stdlib/math/base/special/csch]: compute the hyperbolic cotangent of a number. +- [`@stdlib/math/base/special/coth`][@stdlib/math/base/special/coth]: compute the hyperbolic cotangent of a number. - [`@stdlib/math/base/special/sinh`][@stdlib/math/base/special/sinh]: compute the hyperbolic sine of a double-precision floating-point number.
@@ -188,7 +188,7 @@ int main( void ) { [@stdlib/math/base/special/acsch]: https://github.com/stdlib-js/math/tree/main/base/special/acsch -[@stdlib/math/base/special/csch]: https://github.com/stdlib-js/math/tree/main/base/special/csch +[@stdlib/math/base/special/coth]: https://github.com/stdlib-js/math/tree/main/base/special/coth [@stdlib/math/base/special/sinh]: https://github.com/stdlib-js/math/tree/main/base/special/sinh