diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/README.md b/lib/node_modules/@stdlib/math/base/special/binomcoef/README.md index 05c083e25472..c95d565c0561 100644 --- a/lib/node_modules/@stdlib/math/base/special/binomcoef/README.md +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/README.md @@ -143,6 +143,95 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/binomcoef.h" +``` + +#### stdlib_base_binomcoef( n, k ) + +Evaluates the [binomial coefficient][binomial-coefficient] of two integers `n` and `k`. + +```c +double v = stdlib_base_binomcoef( 8, 2 ); +// returns 28.0 +``` + +The function accepts the following arguments: + +- **n**: `[in] int64_t` input value. +- **k**: `[in] int64_t` input value. + +```c +double stdlib_base_binomcoef( const int64_t n, const int64_t k ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/binomcoef.h" +#include +#include +#include + +int main( void ) { + const int64_t a[] = { 24, 32, 48, 116, 33 }; + const int64_t b[] = { 12, 6, 15, 52, 22 }; + + double out; + int i; + for ( i = 0; i < 5; i++ ) { + out = stdlib_base_binomcoef( a[ i ], b[ i ] ); + printf( "binomcoef(%" PRId64 ", %" PRId64 ") = %lf\n", a[ i ], b[ i ], out ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/benchmark.native.js new file mode 100644 index 000000000000..bd7f92526494 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/benchmark.native.js @@ -0,0 +1,65 @@ +/** +* @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 discreteUniform = require( '@stdlib/random/array/discrete-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 binomcoef = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( binomcoef instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var z; + var i; + var j; + + x = discreteUniform( 100, 20, 70 ); + y = discreteUniform( x.length, 0, 20 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + j = i % x.length; + z = binomcoef( x[ j ], y[ j ] ); + if ( isnan( z ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/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/binomcoef/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..070552abc4ae --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/benchmark/c/native/benchmark.c @@ -0,0 +1,135 @@ +/** +* @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/binomcoef.h" +#include +#include +#include +#include +#include + +#define NAME "binomcoef" +#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 n; + double k; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + n = (int64_t)round( 500.0 * rand_double() ); + k = (int64_t)round( 500.0 * rand_double() ); + y = stdlib_base_binomcoef( n, k ); + 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/binomcoef/binding.gyp b/lib/node_modules/@stdlib/math/base/special/binomcoef/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/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/binomcoef/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/binomcoef/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/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/binomcoef/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/binomcoef/examples/c/example.c new file mode 100644 index 000000000000..fb6bc1e451f2 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @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/binomcoef.h" +#include +#include +#include + +int main( void ) { + const int64_t a[] = { 24, 32, 48, 116, 33 }; + const int64_t b[] = { 12, 6, 15, 52, 22 }; + + double out; + int i; + for ( i = 0; i < 5; i++ ) { + out = stdlib_base_binomcoef( a[ i ], b[ i ] ); + printf( "binomcoef(%" PRId64 ", %" PRId64 ") = %lf\n", a[ i ], b[ i ], out ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/include.gypi b/lib/node_modules/@stdlib/math/base/special/binomcoef/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/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 binomial coefficient of two integers. +*/ +double stdlib_base_binomcoef( const int64_t n, const int64_t k ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_BINOMCOEF_H diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/lib/native.js b/lib/node_modules/@stdlib/math/base/special/binomcoef/lib/native.js new file mode 100644 index 000000000000..7d496aa11fc8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/lib/native.js @@ -0,0 +1,55 @@ +/** +* @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 binomial coefficient of two integers. +* +* @private +* @param {integer} n - input value +* @param {integer} k - second input value +* @returns {number} function value +* +* @example +* var v = binomcoef( 8, 2 ); +* // returns 28.0 +* +* @example +* var v = binomcoef( 0, 0 ); +* // returns 1.0 +* +* @example +* var v = binomcoef( -4, 2 ); +* // returns 10.0 +*/ +function binomcoef( n, k ) { + return addon( n, k ); +} + + +// EXPORTS // + +module.exports = binomcoef; diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/manifest.json b/lib/node_modules/@stdlib/math/base/special/binomcoef/manifest.json new file mode 100644 index 000000000000..3d8560d1ff72 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/manifest.json @@ -0,0 +1,90 @@ +{ + "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": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/binary", + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/gcd", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/pinf", + "@stdlib//constants/float64/max-safe-integer" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/gcd", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/pinf", + "@stdlib//constants/float64/max-safe-integer" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floor", + "@stdlib/math/base/special/gcd", + "@stdlib/math/base/assert/is-odd", + "@stdlib/constants/float64/pinf", + "@stdlib//constants/float64/max-safe-integer" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/src/Makefile b/lib/node_modules/@stdlib/math/base/special/binomcoef/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/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/binomcoef/src/addon.c b/lib/node_modules/@stdlib/math/base/special/binomcoef/src/addon.c new file mode 100644 index 000000000000..a513c406c10e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/src/addon.c @@ -0,0 +1,22 @@ +/** +* @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/binomcoef.h" +#include "stdlib/math/base/napi/binary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_LL_D( stdlib_base_binomcoef ) diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/src/main.c b/lib/node_modules/@stdlib/math/base/special/binomcoef/src/main.c new file mode 100644 index 000000000000..db5846659d48 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/src/main.c @@ -0,0 +1,127 @@ +/** +* @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/binomcoef.h" +#include "stdlib/math/base/special/floor.h" +#include "stdlib/math/base/special/gcd.h" +#include "stdlib/math/base/assert/is_odd.h" +#include "stdlib/constants/float64/pinf.h" +#include "stdlib//constants/float64/max_safe_integer.h" +#include + +/** +* Computes the binomial coefficient of two integers. +* +* @param n input value +* @param k second input value +* @return function value +* +* @example +* double out = stdlib_base_binomcoef( 8, 2 ); +* // returns 28.0 +*/ +double stdlib_base_binomcoef( const int64_t n, const int64_t k ) { + double res; + double sgn; + int64_t nc; + int64_t kc; + int64_t d; + double b; + double c; + double g; + double s; + + if ( k < 0 ) { + return 0.0; + } + sgn = 1.0; + nc = n; + if ( nc < 0 ) { + nc = -nc + k - 1; + if ( stdlib_base_is_odd( (double)k ) ) { + sgn *= -1.0; + } + } + if ( k > nc ) { + return 0.0; + } + if ( k == 0 || k == nc ) { + return sgn; + } + if ( k == 1 || k == nc - 1 ) { + return sgn * nc; + } + + // Minimize the number of computed terms by leveraging symmetry: + kc = k; + if ( nc - kc < kc ) { + kc = nc - kc; + } + s = stdlib_base_floor( (double)STDLIB_CONSTANT_FLOAT64_MAX_SAFE_INTEGER / (double)nc ); + + // Use a standard algorithm for computing the binomial coefficient + res = 1.0; + for ( d = 1; d <= kc; d++ ) { + // Check for potential overflow... + if ( res > s ) { + break; + } + res *= nc; + res /= d; + nc -= 1; + } + + // If we did not early exit from the previous loop, the answer is exact, and we can simply return... + if ( d > kc ) { + return sgn * res; + } + + /* + * Let `N` equal the provided `n`. + * + * We want to calculate C(N,k), and, at this point, we have calculated + * + * res = C(N,n) = C(N,N-n) = C(N,d-1) + * + * where `N-n = d-1` and, hence, `n = N - d + 1`. + * + * Given the following identity, + * + * C(N,k) = C(N,d-1) * C(N-d+1,k-d+1) / C(k,k-d+1) + * = C(N,d-1) * C(n,k-d+1) / C(k,k-d+1) + * + * we can leverage recursion to perform argument reduction. + */ + b = stdlib_base_binomcoef( nc, kc - d + 1 ); + if ( b == STDLIB_CONSTANT_FLOAT64_PINF ) { + return sgn * b; + } + c = stdlib_base_binomcoef( kc, kc - d + 1 ) ; + + /* + * At this point, the result should be `res*b/c`. + * + * To help guard against overflow and precision loss, we calculate the greatest common divisor (gcd). In this case, we pick `b`, as `b` should be less than `res` in most (if not all) cases. + */ + g = stdlib_base_gcd( b, c ); + b /= g; + c /= g; + res /= c; + + return sgn * res * b; +} diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/binomcoef/test/test.native.js new file mode 100644 index 000000000000..610b51be8ce8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/test/test.native.js @@ -0,0 +1,145 @@ +/** +* @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 PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var binomcoef = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( binomcoef instanceof Error ) +}; + + +// FIXTURES // + +var integers = require( './fixtures/julia/integers.json' ); +var negativeN = require( './fixtures/julia/negative_n.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof binomcoef, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function evaluates the binomial coefficient for integers `n` and `k`', opts, function test( t ) { + var expected; + var n; + var k; + var v; + var i; + + n = integers.n; + k = integers.k; + expected = integers.expected; + for ( i = 0; i < n.length; i++ ) { + v = binomcoef( n[ i ], k[ i ] ); + t.strictEqual( v, expected[ i ], 'returns expected value. actual: '+v+'. expected: '+expected[i]+'. n: '+n[i]+'. k: '+k[i]+'.' ); + } + t.end(); +}); + +tape( 'the function evaluates the binomial coefficient for integers `n` and `k` (negative `n`)', opts, function test( t ) { + var expected; + var n; + var k; + var v; + var i; + + n = negativeN.n; + k = negativeN.k; + expected = negativeN.expected; + for ( i = 0; i < n.length; i++ ) { + v = binomcoef( n[ i ], k[ i ] ); + t.strictEqual( v, expected[ i ], 'returns expected value. actual: '+v+'. expected: '+expected[i]+'. n: '+n[i]+'. k: '+k[i]+'.' ); + } + t.end(); +}); + +tape( 'the function returns `0` for a negative integer `k`', opts, function test( t ) { + var v = binomcoef( 2, -1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + v = binomcoef( 2, -2 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `0` when `k` is greater than `n`', opts, function test( t ) { + var v = binomcoef( 2, 4 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + v = binomcoef( 2, 10 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function accurately computes the binomial coefficient for large `n` and `k`', opts, function test( t ) { + var expected; + var actual; + var values; + var i; + + values = [ + // Ref: https://github.com/stdlib-js/stdlib/issues/1155 + [ 54, 23 ], + [ 55, 24 ], + [ 56, 22 ], + [ 58, 20 ], + [ 69, 17 ], + + // Ref: https://github.com/stdlib-js/stdlib/issues/2150 + [ 300, 251 ], + [ 2000, 1996 ], + [ 2000, 1995 ], + + [ 2000, 300 ], + [ -2000, 1001 ] + ]; + expected = [ + 1085929983159840, + 2488589544741300, + 2142582442263900, + 1847253511032930, + 5964720367660956, + + 6.200662003268765e+56, // WolframAlpha: 6.200662003268765320314457726802431127732140827377427408e+56 => this rounds to 6.2006620032687655e+56 in double-precision, so our result is not exact + 6.646684995e11, // WolframAlpha + 2.653356650004e14, // WolframAlpha + + PINF, // WolframAlpha: 3.6138049959364381241541773135834895526117637552492102675890e365 => infinity + NINF // WolframAlpha: -6212726302547248943133393518689898810619042382187174496119933651807218473290085190443308693249726931905654524951735633993615148963537079040480876804607587628658687248681228371656448363185155840441275134714249565928844545934754541325368702966654802850582801504985896180577841412681050734479273999502981682266635670408756877361829065182058330847973326377058381557272516399127743698150193905932210497559 => -infinity + ]; + for ( i = 0; i < values.length; i++ ) { + actual = binomcoef( values[i][0], values[i][1] ); + t.strictEqual( actual, expected[ i ], 'returns expected value' ); + } + t.end(); +});