From 2d05be528ac9ae20949c93c565f63716b4f330b3 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 04:17:30 -0800 Subject: [PATCH 01/20] feat: add the C src files --- .../stats/base/dists/hypergeometric/pmf.h | 44 +++++++++++ .../dists/hypergeometric/pmf/src/Makefile | 70 ++++++++++++++++ .../base/dists/hypergeometric/pmf/src/addon.c | 23 ++++++ .../base/dists/hypergeometric/pmf/src/main.c | 79 +++++++++++++++++++ 4 files changed, 216 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h new file mode 100644 index 000000000000..893ee3039d08 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h @@ -0,0 +1,44 @@ +/** + * @license Apache-2.0 + * + * Copyright (c) 2025 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. + */ + +#ifndef STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H +#define STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H + +/* + * 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 + +/** + * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. + * + * @param x input value + * @param N population size + * @param K subpopulation size + * @param n number of draws + * @return evaluated PMF + */ +double stdlib_base_dists_hypergeometric_pmf( const double x, const double N, const double K, const double n ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/stats/base/dists/hypergeometric/pmf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c new file mode 100644 index 000000000000..bdd253a68744 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/napi/quaternary.h" +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_DDDD_D( stdlib_base_dists_hypergeometric_pmf ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c new file mode 100644 index 000000000000..924b08d20e2a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -0,0 +1,79 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/special/exp.h" +#include "stdlib/math/base/special/factorialln.h" +#include "stdlib/math/base/special/max.h" +#include "stdlib/math/base/special/min.h" +#include "stdlib/constants/float64/pinf.h" + +/** +* Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. +* +* @param x input value +* @param N population size +* @param K subpopulation size +* @param n number of draws +* @return evaluated PMF, or NaN if inputs are invalid +* +* @example +* double sd = stdlib_base_dists_hypergeometric_pmf( 1.0, 8, 4, 2 ); +* // returns ~0.571 +* +* @example +* double sd = stdlib_base_dists_hypergeometric_pmf( 0.0, 8, 4, 2 ); +* // returns ~0.214 +* +* @example +* double sd = stdlib_base_dists_hypergeometric_pmf( NaN, 10, 5, 2 ); +* // returns NaN +*/ +double stdlib_base_dists_hypergeometric_pmf ( const double x, const double N, const double K, const double n ) { + if ( + stdlib_base_is_nan(x) || + stdlib_base_is_nan(N) || + stdlib_base_is_nan(K) || + stdlib_base_is_nan(n) || + !stdlib_base_is_nonnegative_integer(N) || + !stdlib_base_is_nonnegative_integer(K) || + !stdlib_base_is_nonnegative_integer(n) || + N == STDLIB_CONSTANT_FLOAT64_PINF || + K == STDLIB_CONSTANT_FLOAT64_PINF || + K > N || + n > N + ) { + return NAN; + } + + double mins = stdlib_base_max(0, n + K - N); + double maxs = stdlib_base_min(K, n); + + if (stdlib_base_is_nonnegative_integer(x) && mins <= x && x <= maxs) { + double lnum = stdlib_base_factorialln(n) + stdlib_base_factorialln(K) + + stdlib_base_factorialln(N - n) + stdlib_base_factorialln(N - K); + double ldenom = stdlib_base_factorialln(N) + stdlib_base_factorialln(x) + + stdlib_base_factorialln(n - x) + + stdlib_base_factorialln(K - x) + + stdlib_base_factorialln(N - K + x - n); + double lpmf = lnum - ldenom; + return stdlib_base_exp(lpmf); + } + return 0.0; +} From 6e8eb2d4f409a14fa72ea1dee60c82a2934e2d27 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 04:17:54 -0800 Subject: [PATCH 02/20] feat: add the C benchmark and example files --- .../hypergeometric/pmf/benchmark/c/Makefile | 146 ++++++++++++++++++ .../pmf/benchmark/c/benchmark.c | 145 +++++++++++++++++ .../hypergeometric/pmf/examples/c/Makefile | 146 ++++++++++++++++++ .../hypergeometric/pmf/examples/c/example.c | 48 ++++++ 4 files changed, 485 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..93cf983eaea1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c @@ -0,0 +1,145 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/stats/base/dists/hypergeometric/pmf.h" +#include "stdlib/math/base/special/round.h" +#include +#include +#include +#include +#include + +#define NAME "hypergeometric-pmf" +#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 [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double N[ 100 ]; + double K[ 100 ]; + double n[ 100 ]; + double x[ 100 ]; + double pmf; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + N[i] = stdlib_base_round(random_uniform(1.0, 100.0)); + K[i] = stdlib_base_round(random_uniform(0.0, N[i])); + n[i] = stdlib_base_round(random_uniform(0.0, N[i])); + x[i] = stdlib_base_round(random_uniform(0.0, n[i])); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + pmf = stdlib_base_dists_hypergeometric_pmf( x[ i % 100 ], N[ i % 100 ], K[ i % 100 ], n[ i % 100 ] ); + if ( pmf != pmf ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( pmf != pmf ) { + 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::%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/stats/base/dists/hypergeometric/pmf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/stats/base/dists/hypergeometric/pmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c new file mode 100644 index 000000000000..3b7f83892f26 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/stats/base/dists/hypergeometric/pmf.h" +#include "stdlib/math/base/special/round.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double N; + double K; + double n; + double x; + double pmf; + int i; + + for ( i = 0; i < 10; i++ ) { + N = stdlib_base_round(random_uniform(1.0, 20.0)); + K = stdlib_base_round(random_uniform(0.0, N)); + n = stdlib_base_round(random_uniform(0.0, N)); + x = stdlib_base_round(random_uniform(0.0, n)); + pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); + + printf( "N: %lf, K: %lf, n: %lf, x: %lf, PMF: %lf\n", N, K, n, x, pmf ); + } + + return 0; +} From 8daa9eec6ffb8ebe9f0b3f27b7e21d2d1f7b7107 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 04:35:56 -0800 Subject: [PATCH 03/20] feat: add the JS native files --- .../pmf/benchmark/benchmark.native.js | 77 ++++++++++++ .../dists/hypergeometric/pmf/lib/native.js | 49 ++++++++ .../hypergeometric/pmf/test/test.native.js | 119 ++++++++++++++++++ 3 files changed, 245 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..19a409ca2958 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js @@ -0,0 +1,77 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var round = require( '@stdlib/math/base/special/round' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var pmf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( pmf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var N; + var K; + var n; + var x; + var y; + var i; + + len = 100; + N = new Float64Array( len ); + K = new Float64Array( len ); + n = new Float64Array( len ); + x = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + N[ i ] = round( ( randu() * 90.0 ) + 10.0 ); + K[ i ] = round( randu() * N[ i ] ); + n[ i ] = round( randu() * N[ i ] ); + x[ i ] = round( randu() * n[ i ] ); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = pmf( x[ i % len ], N[ i % len ], K[ i % len ], n[ i % len ] ); + 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/stats/base/dists/hypergeometric/pmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js new file mode 100644 index 000000000000..e055e13f9cd3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js @@ -0,0 +1,49 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 // + +/** +* Evaluates the probability mass function (PMF) for a hypergeometric distribution. +* +* @private +* @param {number} x - number of successes +* @param {number} N - population size +* @param {number} K - subpopulation size +* @param {number} n - number of draws +* @returns {number} evaluated PMF +* +* @example +* var p = pmf( 2, 10, 5, 4 ); +* // returns ~0.238 +*/ +function pmf( x, N, K, n ) { + return addon( x, N, K, n ); +} + + +// EXPORTS // + +module.exports = pmf; diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js new file mode 100644 index 000000000000..22a42fe7a34a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -0,0 +1,119 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tryRequire = require( '@stdlib/utils/try-require' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); + + +// VARIABLES // + +var pmf = tryRequire(resolve(__dirname, './../lib/native.js')); +var opts = { + 'skip': (pmf instanceof Error) +}; + + +// TESTS // + +tape('main export is a function', opts, function test(t) { + t.ok(true, __filename); + t.strictEqual(typeof pmf, 'function', 'main export is a function'); + t.end(); +}); + +tape('if provided `NaN` for any parameter, the function returns `NaN`', opts, function test(t) { + var v; + + v = pmf(NaN, 10, 5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, NaN, 5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, NaN, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, 5, NaN); + t.equal(isnan(v), true, 'returns NaN'); + + t.end(); +}); + +tape('if provided invalid inputs, the function returns `NaN`', opts, function test(t) { + var v; + + v = pmf(2, -10, 5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10.5, 5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, -5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, 5.5, 2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, 5, -2); + t.equal(isnan(v), true, 'returns NaN'); + + v = pmf(2, 10, 5, 2.5); + t.equal(isnan(v), true, 'returns NaN'); + + t.end(); +}); + +tape('the function evaluates the PMF for a hypergeometric distribution', opts, function test(t) { + var testCases = [{ + 'x': 1.0, + 'N': 8, + 'K': 4, + 'n': 2, + 'expected': 0.571 + }, + { + 'x': 2.0, + 'N': 8, + 'K': 4, + 'n': 2, + 'expected': 0.214 + }, + { + 'x': 0.0, + 'N': 8, + 'K': 4, + 'n': 2, + 'expected': 0.214 + }]; + var tol = 1e-3; + + testCases.forEach(function evaluateTestCase(testCase) { + var computedPMF = pmf(testCase.x, testCase.N, testCase.K, testCase.n); + var delta = abs(computedPMF - testCase.expected); + t.ok(delta <= tol, 'within tolerance. x: ' + testCase.x + ', N: ' + testCase.N + ', K: ' + testCase.K + ', n: ' + testCase.n + ', y: ' + computedPMF + ', expected: ' + testCase.expected + ', Δ: ' + delta + ', tol: ' + tol); + }); + + t.end(); +}); From f370792c9695be090792352069785595af90dcbc Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 04:36:17 -0800 Subject: [PATCH 04/20] build: added the json and gyp dependency files --- .../base/dists/hypergeometric/pmf/binding.gyp | 149 ++++++++++++++++++ .../dists/hypergeometric/pmf/include.gypi | 48 ++++++ .../dists/hypergeometric/pmf/manifest.json | 96 +++++++++++ .../dists/hypergeometric/pmf/package.json | 3 + 4 files changed, 296 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp new file mode 100644 index 000000000000..114dcb77c6aa --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp @@ -0,0 +1,149 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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)", + "src/addon.c", + ], + # 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/stats/base/dists/hypergeometric/pmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi new file mode 100644 index 000000000000..235be47d6d3b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi @@ -0,0 +1,48 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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": [ + " Date: Sun, 5 Jan 2025 04:36:31 -0800 Subject: [PATCH 05/20] docs: update README with C API documentation --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../base/dists/hypergeometric/pmf/README.md | 105 ++++++++++++++++++ 1 file changed, 105 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index 29f90e9aaf98..240e4b761083 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -157,6 +157,111 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" +``` + +#### stdlib_base_dists_hypergeometric_pmf( x, N, K, n ) + +Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. + +```c +double out = stdlib_base_dists_hypergeometric_stdev( 16, 11, 4 ); +// returns ~0.829 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **N**: `[in] double` population size. +- **K**: `[in] double` subpopulation size. +- **n**: `[in] double` number of draws. + +```c +double stdlib_base_dists_hypergeometric_pmf ( const double x, const double N, const double K, const double n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" +#include "stdlib/math/base/special/round.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double N; + double K; + double n; + double x; + double pmf; + int i; + + for ( i = 0; i < 10; i++ ) { + N = stdlib_base_round(random_uniform(1.0, 20.0)); + K = stdlib_base_round(random_uniform(0.0, N)); + n = stdlib_base_round(random_uniform(0.0, N)); + x = stdlib_base_round(random_uniform(0.0, n)); + pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); + + printf( "N: %lf, K: %lf, n: %lf, x: %lf, PMF: %lf\n", N, K, n, x, pmf ); + } + + return 0; +} +``` + +
+ + + +
+ + +
From 7e4dedad14daf0ff43d13dfd38bf1755890d2e27 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 09:59:40 -0800 Subject: [PATCH 06/20] refactor: add native tests from test.pmf.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../hypergeometric/pmf/test/test.native.js | 175 ++++++++++++------ 1 file changed, 119 insertions(+), 56 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index 22a42fe7a34a..afb574d8fea1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -25,6 +25,9 @@ var tape = require( 'tape' ); var tryRequire = require( '@stdlib/utils/try-require' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var abs = require( '@stdlib/math/base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); // VARIABLES // @@ -35,85 +38,145 @@ var opts = { }; +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + // TESTS // -tape('main export is a function', opts, function test(t) { - t.ok(true, __filename); - t.strictEqual(typeof pmf, 'function', 'main export is a function'); +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof pmf, 'function', 'main export is a function' ); t.end(); }); -tape('if provided `NaN` for any parameter, the function returns `NaN`', opts, function test(t) { - var v; +tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, function test( t ) { + var y = pmf( NaN, 10, 10, 5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = pmf( 0.0, NaN, 10, 5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = pmf( 0.0, 10, NaN, 5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = pmf( 0.0, 10, 10, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + t.end(); +}); - v = pmf(NaN, 10, 5, 2); - t.equal(isnan(v), true, 'returns NaN'); +tape( 'if provided an integer `x` greater than `min( n, K )`, the function returns `0` (provided all parameters are valid)', opts, function test( t ) { + var y = pmf( PINF, 20, 20, 10 ); + t.equal( y, 0.0, 'returns 0' ); - v = pmf(2, NaN, 5, 2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 11, 20, 20, 10 ); + t.equal( y, 0.0, 'returns 0' ); - v = pmf(2, 10, NaN, 2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 100, 20, 20, 10 ); + t.equal( y, 0.0, 'returns 0' ); - v = pmf(2, 10, 5, NaN); - t.equal(isnan(v), true, 'returns NaN'); + t.end(); +}); + +tape( 'if provided an integer for `x` smaller than `max( 0, n + K - N )`, the function returns `0`', opts, function test( t ) { + var y = pmf( NINF, 40, 20, 10 ); + t.equal( y, 0.0, 'returns 0' ); + + y = pmf( -1.0, 40, 20, 10 ); + t.equal( y, 0.0, 'returns 0' ); + + y = pmf( -2.0, 30, 20, 20 ); + t.equal( y, 0.0, 'returns 0' ); t.end(); }); -tape('if provided invalid inputs, the function returns `NaN`', opts, function test(t) { - var v; +tape( 'if provided an `N` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { + var y; + + y = pmf( 2.0, 30.5, 20, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 2.0, -2, 20, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 2.0, -1, 20, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, -10, 5, 2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 0.0, 20.5, 20, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, 10.5, 5, 2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 0.0, PINF, 20, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, 10, -5, 2); - t.equal(isnan(v), true, 'returns NaN'); + t.end(); +}); + +tape( 'if provided a `K` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { + var y; + + y = pmf( 2.0, 20, 3.5, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, 10, 5.5, 2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 2.0, 20, -2, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, 10, 5, -2); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 2.0, 20, -1, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); - v = pmf(2, 10, 5, 2.5); - t.equal(isnan(v), true, 'returns NaN'); + y = pmf( 0.0, 20, 2.5, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 0.0, 20, PINF, 10 ); + t.equal( isnan( y ), true, 'returns NaN' ); t.end(); }); -tape('the function evaluates the PMF for a hypergeometric distribution', opts, function test(t) { - var testCases = [{ - 'x': 1.0, - 'N': 8, - 'K': 4, - 'n': 2, - 'expected': 0.571 - }, - { - 'x': 2.0, - 'N': 8, - 'K': 4, - 'n': 2, - 'expected': 0.214 - }, - { - 'x': 0.0, - 'N': 8, - 'K': 4, - 'n': 2, - 'expected': 0.214 - }]; - var tol = 1e-3; - - testCases.forEach(function evaluateTestCase(testCase) { - var computedPMF = pmf(testCase.x, testCase.N, testCase.K, testCase.n); - var delta = abs(computedPMF - testCase.expected); - t.ok(delta <= tol, 'within tolerance. x: ' + testCase.x + ', N: ' + testCase.N + ', K: ' + testCase.K + ', n: ' + testCase.n + ', y: ' + computedPMF + ', expected: ' + testCase.expected + ', Δ: ' + delta + ', tol: ' + tol); - }); +tape( 'if provided an `n` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { + var y; + + y = pmf( 2.0, 40, 20, 3.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 2.0, 40, 20, -2 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 2.0, 40, 20, -1 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 0.0, 40, 20, 2.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = pmf( 0.0, 40, 20, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); +tape( 'the function evaluates the pmf for `x`', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var N; + var K; + var n; + var y; + var i; + + expected = data.expected; + x = data.x; + N = data.N; + K = data.K; + n = data.n; + for ( i = 0; i < x.length; i++ ) { + y = pmf( x[i], N[i], K[i], n[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', N: '+N[i]+', K: '+K[i]+', n: '+n[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1040.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. N: '+N[i]+'. K: '+K[i]+'. n: '+n[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } t.end(); }); From 1a64aa44a8c6e25f8a2828b5d4cd61841ef66685 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Tue, 7 Jan 2025 23:33:06 -0800 Subject: [PATCH 07/20] refactor: fixed the formatting issues --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../base/dists/hypergeometric/pmf/README.md | 18 +- .../pmf/benchmark/c/benchmark.c | 24 +- .../base/dists/hypergeometric/pmf/binding.gyp | 267 ++++++++++-------- .../hypergeometric/pmf/examples/c/example.c | 38 +-- .../dists/hypergeometric/pmf/include.gypi | 53 ++-- .../base/dists/hypergeometric/pmf/src/main.c | 54 +--- 6 files changed, 228 insertions(+), 226 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index 240e4b761083..44ebba103758 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -222,32 +222,32 @@ double stdlib_base_dists_hypergeometric_pmf ( const double x, const double N, co ### Examples ```c -#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include "stdlib/math/base/special/round.h" -#include +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include +#include static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v*(max-min) ); + return min + ( v * ( max - min ) ); } int main( void ) { + double pmf; double N; double K; double n; double x; - double pmf; int i; for ( i = 0; i < 10; i++ ) { - N = stdlib_base_round(random_uniform(1.0, 20.0)); - K = stdlib_base_round(random_uniform(0.0, N)); - n = stdlib_base_round(random_uniform(0.0, N)); - x = stdlib_base_round(random_uniform(0.0, n)); + N = stdlib_base_round( random_uniform( 0.0, 20.0 ) ); + K = stdlib_base_round( random_uniform( 0.0, N ) ); + n = stdlib_base_round( random_uniform( 0.0, N ) ); + x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "N: %lf, K: %lf, n: %lf, x: %lf, PMF: %lf\n", N, K, n, x, pmf ); + printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); } return 0; diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c index 93cf983eaea1..34bbb972bd4d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c @@ -16,13 +16,13 @@ * limitations under the License. */ -#include "stdlib/stats/base/dists/hypergeometric/pmf.h" +#include #include "stdlib/math/base/special/round.h" -#include -#include +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include +#include +#include #include -#include #define NAME "hypergeometric-pmf" #define ITERATIONS 1000000 @@ -72,7 +72,7 @@ static void print_results( double elapsed ) { static double tic( void ) { struct timeval now; gettimeofday( &now, NULL ); - return (double)now.tv_sec + (double)now.tv_usec/1.0e6; + return (double)now.tv_sec + (double)now.tv_usec / 1.0e6; } /** @@ -84,7 +84,7 @@ static double tic( void ) { */ static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v*(max-min) ); + return min + ( v * ( max - min ) ); } /** @@ -103,10 +103,10 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - N[i] = stdlib_base_round(random_uniform(1.0, 100.0)); - K[i] = stdlib_base_round(random_uniform(0.0, N[i])); - n[i] = stdlib_base_round(random_uniform(0.0, N[i])); - x[i] = stdlib_base_round(random_uniform(0.0, n[i])); + N[ i ] = stdlib_base_round( random_uniform( 1.0, 100.0 ) ); + K[ i ] = stdlib_base_round( random_uniform( 0.0, N[ i ] ) ); + n[ i ] = stdlib_base_round( random_uniform( 0.0, N[ i ] ) ); + x[ i ] = stdlib_base_round( random_uniform( 0.0, n[ i ] ) ); } t = tic(); @@ -131,7 +131,7 @@ int main( void ) { double elapsed; int i; - // Use the current time to seed the random number generator: + // Use the current time to seed the random number generator: srand( time( NULL ) ); print_version(); @@ -139,7 +139,7 @@ int main( void ) { printf( "# c::%s\n", NAME ); elapsed = benchmark(); print_results( elapsed ); - printf( "ok %d benchmark finished\n", i+1 ); + printf( "ok %d benchmark finished\n", i + 1 ); } print_summary( REPEATS, REPEATS ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp index 114dcb77c6aa..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/binding.gyp @@ -19,131 +19,152 @@ # [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: + # 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"', { - # 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)", - "src/addon.c", - ], - # 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", + # 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', ], - # C++ specific compiler flags: - "cflags_cpp": [ - # Specify the C++ standard to which a program is expected to conform: - "-std=c++11", + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', ], - # 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: + }, + ], # 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': [ { - "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 + '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/stats/base/dists/hypergeometric/pmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c index 3b7f83892f26..d3b73fb8baad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c @@ -16,33 +16,33 @@ * limitations under the License. */ -#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include "stdlib/math/base/special/round.h" -#include +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include +#include static double random_uniform( const double min, const double max ) { - double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v*(max-min) ); + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v * ( max - min ) ); } int main( void ) { - double N; - double K; - double n; - double x; - double pmf; - int i; + double pmf; + double N; + double K; + double n; + double x; + int i; - for ( i = 0; i < 10; i++ ) { - N = stdlib_base_round(random_uniform(1.0, 20.0)); - K = stdlib_base_round(random_uniform(0.0, N)); - n = stdlib_base_round(random_uniform(0.0, N)); - x = stdlib_base_round(random_uniform(0.0, n)); - pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); + for ( i = 0; i < 10; i++ ) { + N = stdlib_base_round( random_uniform( 0.0, 20.0 ) ); + K = stdlib_base_round( random_uniform( 0.0, N ) ); + n = stdlib_base_round( random_uniform( 0.0, N ) ); + x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); + pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "N: %lf, K: %lf, n: %lf, x: %lf, PMF: %lf\n", N, K, n, x, pmf ); - } + printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); + } - return 0; + return 0; } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi index 235be47d6d3b..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include.gypi @@ -21,28 +21,33 @@ # [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": [ - " N || - n > N - ) { - return NAN; - } +double stdlib_base_dists_hypergeometric_pmf( const double x, const double N, const double K, const double n ) { + if ( stdlib_base_is_nan( x ) || stdlib_base_is_nan( N ) || stdlib_base_is_nan( K ) || stdlib_base_is_nan( n ) || !stdlib_base_is_nonnegative_integer( N ) || !stdlib_base_is_nonnegative_integer( K ) || !stdlib_base_is_nonnegative_integer( n ) || N == STDLIB_CONSTANT_FLOAT64_PINF || K == STDLIB_CONSTANT_FLOAT64_PINF || K > N || n > N ) { + return NAN; + } - double mins = stdlib_base_max(0, n + K - N); - double maxs = stdlib_base_min(K, n); + double mins = stdlib_base_max( 0, n + K - N ); + double maxs = stdlib_base_min( K, n ); - if (stdlib_base_is_nonnegative_integer(x) && mins <= x && x <= maxs) { - double lnum = stdlib_base_factorialln(n) + stdlib_base_factorialln(K) + - stdlib_base_factorialln(N - n) + stdlib_base_factorialln(N - K); - double ldenom = stdlib_base_factorialln(N) + stdlib_base_factorialln(x) + - stdlib_base_factorialln(n - x) + - stdlib_base_factorialln(K - x) + - stdlib_base_factorialln(N - K + x - n); - double lpmf = lnum - ldenom; - return stdlib_base_exp(lpmf); - } - return 0.0; + if ( stdlib_base_is_nonnegative_integer( x ) && mins <= x && x <= maxs ) { + double lnum = stdlib_base_factorialln( n ) + stdlib_base_factorialln( K ) + stdlib_base_factorialln( N - n ) + stdlib_base_factorialln( N - K ); + double ldenom = stdlib_base_factorialln( N ) + stdlib_base_factorialln( x ) + stdlib_base_factorialln( n - x ) + stdlib_base_factorialln( K - x ) + stdlib_base_factorialln( N - K + x - n ); + double lpmf = lnum - ldenom; + return stdlib_base_exp( lpmf ); + } + return 0.0; } From 0487694f2ad11e9101da3a1a7378b772d27a8402 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 8 Jan 2025 19:25:21 -0800 Subject: [PATCH 08/20] refactor: fixed extra spaces and tabs --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/hypergeometric/pmf/README.md | 3 --- .../base/dists/hypergeometric/pmf/benchmark/c/benchmark.c | 2 +- .../stats/base/dists/hypergeometric/pmf/examples/c/example.c | 3 --- 3 files changed, 1 insertion(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index 44ebba103758..d53adbe03b4c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -246,11 +246,8 @@ int main( void ) { n = stdlib_base_round( random_uniform( 0.0, N ) ); x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); } - - return 0; } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c index 34bbb972bd4d..750a2ee96939 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c @@ -131,7 +131,7 @@ int main( void ) { double elapsed; int i; - // Use the current time to seed the random number generator: + // Use the current time to seed the random number generator: srand( time( NULL ) ); print_version(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c index d3b73fb8baad..be22038edb07 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c @@ -40,9 +40,6 @@ int main( void ) { n = stdlib_base_round( random_uniform( 0.0, N ) ); x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); } - - return 0; } From 8ea1620da17a693b0cd1f8b9afab38360273b0e4 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 8 Jan 2025 19:53:08 -0800 Subject: [PATCH 09/20] refactor: fixed examples in native.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../dists/hypergeometric/pmf/lib/native.js | 54 +++++++++++++++++-- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js index e055e13f9cd3..dc642acb31a1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js @@ -10,7 +10,7 @@ * 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, +* 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. @@ -36,8 +36,56 @@ var addon = require( './../src/addon.node' ); * @returns {number} evaluated PMF * * @example -* var p = pmf( 2, 10, 5, 4 ); -* // returns ~0.238 +* var y = pmf( 1.0, 8, 4, 2 ); +* // returns ~0.571 +* +* @example +* var y = pmf( 2.0, 8, 4, 2 ); +* // returns ~0.214 +* +* @example +* var y = pmf( 0.0, 8, 4, 2 ); +* // returns ~0.214 +* +* @example +* var y = pmf( 1.5, 8, 4, 2 ); +* // returns 0.0 +* +* @example +* var y = pmf( NaN, 10, 5, 2 ); +* // returns NaN +* +* @example +* var y = pmf( 0.0, NaN, 5, 2 ); +* // returns NaN +* +* @example +* var y = pmf( 0.0, 10, NaN, 2 ); +* // returns NaN +* +* @example +* var y = pmf( 0.0, 10, 5, NaN ); +* // returns NaN +* +* @example +* var y = pmf( 2.0, 10.5, 5, 2 ); +* // returns NaN +* +* @example +* var y = pmf( 2.0, 5, 1.5, 2 ); +* // returns NaN +* +* @example +* var y = pmf( 2.0, 10, 5, -2.0 ); +* // returns NaN +* +* @example +* var y = pmf( 2.0, 10, 5, 12 ); +* // returns NaN +* +* @example +* var y = pmf( 2.0, 8, 3, 9 ); +* // returns NaN */ function pmf( x, N, K, n ) { return addon( x, N, K, n ); From 4b9eec96d23139178bc5e7fa1d8b4068dbc0284c Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 8 Jan 2025 19:54:34 -0800 Subject: [PATCH 10/20] refactor: fixed header file license --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/hypergeometric/pmf.h | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h index 893ee3039d08..e7d7911b28e4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h @@ -1,20 +1,20 @@ /** - * @license Apache-2.0 - * - * Copyright (c) 2025 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. - */ +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ #ifndef STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H #define STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H From 04bf6e17a7cf05582602464b5fa2978fc64fbcb9 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Fri, 10 Jan 2025 22:27:14 -0800 Subject: [PATCH 11/20] refactor: apply suggestions from previous PRs --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/hypergeometric/pmf/README.md | 2 +- .../stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index d53adbe03b4c..220c732d4810 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -185,7 +185,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_hypergeometric_pmf( x, N, K, n ) -Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. +Evaluates the [probability mass function][pmf] (PMF) for a [hypergeometric][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws). ```c double out = stdlib_base_dists_hypergeometric_stdev( 16, 11, 4 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c index 750a2ee96939..a42973799465 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c @@ -16,13 +16,13 @@ * limitations under the License. */ -#include #include "stdlib/math/base/special/round.h" #include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include #include #include #include +#include #define NAME "hypergeometric-pmf" #define ITERATIONS 1000000 diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c index c9c01faec146..7d92ffd5b425 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -31,7 +31,7 @@ * @param N population size * @param K subpopulation size * @param n number of draws -* @return evaluated PMF, or NaN if inputs are invalid +* @return evaluated PMF * * @example * double sd = stdlib_base_dists_hypergeometric_pmf( 1.0, 8, 4, 2 ); From bb51274fe40947951fb863620269fe8d7a5149cf Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 11 Jan 2025 00:25:13 -0800 Subject: [PATCH 12/20] refactor: fix indentation of comments in header file --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/hypergeometric/pmf.h | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h index e7d7911b28e4..31a6629f3be6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h @@ -20,21 +20,21 @@ #define STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H /* - * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. - */ +* 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 /** - * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. - * - * @param x input value - * @param N population size - * @param K subpopulation size - * @param n number of draws - * @return evaluated PMF - */ +* Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. +* +* @param x input value +* @param N population size +* @param K subpopulation size +* @param n number of draws +* @return evaluated PMF +*/ double stdlib_base_dists_hypergeometric_pmf( const double x, const double N, const double K, const double n ); #ifdef __cplusplus From 3a27ab746c0943faaecd1a508e7c6f31fd32d25e Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Mon, 13 Jan 2025 20:22:06 -0800 Subject: [PATCH 13/20] refactor: added include in main.c and fixed the JS benchmark number generation --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../hypergeometric/pmf/benchmark/benchmark.native.js | 8 ++++---- .../stats/base/dists/hypergeometric/pmf/src/main.c | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js index 19a409ca2958..37d9c6aeb635 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js @@ -55,10 +55,10 @@ bench( pkg+'::native', opts, function benchmark( b ) { n = new Float64Array( len ); x = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - N[ i ] = round( ( randu() * 90.0 ) + 10.0 ); - K[ i ] = round( randu() * N[ i ] ); - n[ i ] = round( randu() * N[ i ] ); - x[ i ] = round( randu() * n[ i ] ); + N[ i ] = round( randu()*100.0 ); + K[ i ] = round( randu()*N ); + n[ i ] = round( randu()*N ); + x[ i ] = round( randu()*10.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c index 7d92ffd5b425..5816e5774990 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -23,6 +23,7 @@ #include "stdlib/math/base/special/factorialln.h" #include "stdlib/math/base/special/max.h" #include "stdlib/math/base/special/min.h" +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" /** * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. From c56302d03404bffad998a6742ab65e7120de480f Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Fri, 28 Feb 2025 20:23:32 -0800 Subject: [PATCH 14/20] feat: temp commit --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../base/dists/hypergeometric/pmf/src/addon.c | 4 +-- .../base/dists/hypergeometric/pmf/src/main.c | 31 +++++++++++-------- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c index bdd253a68744..bdbe052045ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/addon.c @@ -16,8 +16,8 @@ * limitations under the License. */ -#include "stdlib/math/base/napi/quaternary.h" #include "stdlib/stats/base/dists/hypergeometric/pmf.h" +#include "stdlib/math/base/napi/quaternary.h" // cppcheck-suppress shadowFunction -STDLIB_MATH_BASE_NAPI_MODULE_DDDD_D( stdlib_base_dists_hypergeometric_pmf ) +STDLIB_MATH_BASE_NAPI_MODULE_DIII_D( stdlib_base_dists_hypergeometric_pmf ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c index 5816e5774990..5a80c214c776 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -16,14 +16,13 @@ * limitations under the License. */ -#include "stdlib/constants/float64/pinf.h" -#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include "stdlib/math/base/assert/is_nonnegative_integer.h" -#include "stdlib/math/base/special/exp.h" #include "stdlib/math/base/special/factorialln.h" +#include "stdlib/math/base/special/exp.h" #include "stdlib/math/base/special/max.h" #include "stdlib/math/base/special/min.h" -#include "stdlib/stats/base/dists/hypergeometric/pmf.h" +#include /** * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. @@ -35,21 +34,27 @@ * @return evaluated PMF * * @example -* double sd = stdlib_base_dists_hypergeometric_pmf( 1.0, 8, 4, 2 ); +* double y = stdlib_base_dists_hypergeometric_pmf( 1.0, 8, 4, 2 ); * // returns ~0.571 */ -double stdlib_base_dists_hypergeometric_pmf( const double x, const double N, const double K, const double n ) { - if ( stdlib_base_is_nan( x ) || stdlib_base_is_nan( N ) || stdlib_base_is_nan( K ) || stdlib_base_is_nan( n ) || !stdlib_base_is_nonnegative_integer( N ) || !stdlib_base_is_nonnegative_integer( K ) || !stdlib_base_is_nonnegative_integer( n ) || N == STDLIB_CONSTANT_FLOAT64_PINF || K == STDLIB_CONSTANT_FLOAT64_PINF || K > N || n > N ) { - return NAN; +double stdlib_base_dists_hypergeometric_pmf( const double x, const int32_t N, const int32_t K, const int32_t n ) { + double ldenom; + double lnum; + double lpmf; + double maxs; + double mins; + + if ( N < 0 || K < 0 || n < 0 || K > N || n > N ) { + return 0.0/0.0; // NaN } - double mins = stdlib_base_max( 0, n + K - N ); - double maxs = stdlib_base_min( K, n ); + mins = stdlib_base_max( 0, n + K - N ); + maxs = stdlib_base_min( K, n ); if ( stdlib_base_is_nonnegative_integer( x ) && mins <= x && x <= maxs ) { - double lnum = stdlib_base_factorialln( n ) + stdlib_base_factorialln( K ) + stdlib_base_factorialln( N - n ) + stdlib_base_factorialln( N - K ); - double ldenom = stdlib_base_factorialln( N ) + stdlib_base_factorialln( x ) + stdlib_base_factorialln( n - x ) + stdlib_base_factorialln( K - x ) + stdlib_base_factorialln( N - K + x - n ); - double lpmf = lnum - ldenom; + lnum = stdlib_base_factorialln( n ) + stdlib_base_factorialln( K ) + stdlib_base_factorialln( N-n ) + stdlib_base_factorialln( N-K ); + ldenom = stdlib_base_factorialln( N ) + stdlib_base_factorialln( x ) + stdlib_base_factorialln( n-x ) + stdlib_base_factorialln( K-x ) + stdlib_base_factorialln( N-K+x-n ); + lpmf = lnum - ldenom; return stdlib_base_exp( lpmf ); } return 0.0; From aac1d849d008f710686c731eae702cf29fc0b2c9 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 1 Mar 2025 12:25:44 -0800 Subject: [PATCH 15/20] fix: update the C implementation with correct parameter types --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- .../base/dists/hypergeometric/pmf/README.md | 31 ++++----- .../pmf/benchmark/benchmark.native.js | 13 ++-- .../pmf/benchmark/c/benchmark.c | 28 ++++---- .../hypergeometric/pmf/examples/c/example.c | 19 +++--- .../stats/base/dists/hypergeometric/pmf.h | 10 +-- .../dists/hypergeometric/pmf/lib/native.js | 39 ++--------- .../dists/hypergeometric/pmf/manifest.json | 18 ++--- .../base/dists/hypergeometric/pmf/src/main.c | 5 +- .../hypergeometric/pmf/test/test.native.js | 65 +++---------------- 9 files changed, 74 insertions(+), 154 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index 220c732d4810..fde2705fa3d6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -188,19 +188,19 @@ for ( i = 0; i < 10; i++ ) { Evaluates the [probability mass function][pmf] (PMF) for a [hypergeometric][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws). ```c -double out = stdlib_base_dists_hypergeometric_stdev( 16, 11, 4 ); -// returns ~0.829 +double out = stdlib_base_dists_hypergeometric_pmf( 1.0, 8, 4, 2 ); +// returns ~0.571 ``` The function accepts the following arguments: - **x**: `[in] double` input value. -- **N**: `[in] double` population size. -- **K**: `[in] double` subpopulation size. -- **n**: `[in] double` number of draws. +- **N**: `[in] int32_t` population size. +- **K**: `[in] int32_t` subpopulation size. +- **n**: `[in] int32_t` number of draws. ```c -double stdlib_base_dists_hypergeometric_pmf ( const double x, const double N, const double K, const double n ); +double stdlib_base_dists_hypergeometric_pmf ( const double x, const int32_t N, const int32_t K, const int32_t n ); ```
@@ -222,10 +222,11 @@ double stdlib_base_dists_hypergeometric_pmf ( const double x, const double N, co ### Examples ```c -#include "stdlib/math/base/special/round.h" #include "stdlib/stats/base/dists/hypergeometric/pmf.h" -#include +#include "stdlib/math/base/special/round.h" #include +#include +#include static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); @@ -233,20 +234,20 @@ static double random_uniform( const double min, const double max ) { } int main( void ) { - double pmf; - double N; - double K; - double n; + int32_t N; + int32_t K; + int32_t n; double x; + double y; int i; for ( i = 0; i < 10; i++ ) { + x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); N = stdlib_base_round( random_uniform( 0.0, 20.0 ) ); K = stdlib_base_round( random_uniform( 0.0, N ) ); n = stdlib_base_round( random_uniform( 0.0, N ) ); - x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); - pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); + y = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); + printf( "x: %lf, N: %d, K: %d, n: %d, P(X=x;N,K,n): %lf\n", x, N, K, n, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js index 37d9c6aeb635..05c6257f50ac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/benchmark.native.js @@ -23,10 +23,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); -var randu = require( '@stdlib/random/base/randu' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); -var round = require( '@stdlib/math/base/special/round' ); var pkg = require( './../package.json' ).name; @@ -55,15 +54,15 @@ bench( pkg+'::native', opts, function benchmark( b ) { n = new Float64Array( len ); x = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - N[ i ] = round( randu()*100.0 ); - K[ i ] = round( randu()*N ); - n[ i ] = round( randu()*N ); - x[ i ] = round( randu()*10.0 ); + x[ i ] = discreteUniform( 1, 10 ); + N[ i ] = discreteUniform( 1, 100 ); + K[ i ] = discreteUniform( 1, N[ i ] ); + n[ i ] = discreteUniform( 1, N[ i ] ); } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = pmf( x[ i % len ], N[ i % len ], K[ i % len ], n[ i % len ] ); + y = pmf( x[ i%len ], N[ i%len ], K[ i%len ], n[ i%len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c index a42973799465..bafc3b6e0225 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c @@ -16,11 +16,11 @@ * limitations under the License. */ -#include "stdlib/math/base/special/round.h" #include "stdlib/stats/base/dists/hypergeometric/pmf.h" -#include -#include +#include "stdlib/math/base/special/round.h" #include +#include +#include #include #include @@ -93,32 +93,32 @@ static double random_uniform( const double min, const double max ) { * @return elapsed time in seconds */ static double benchmark( void ) { - double elapsed; - double N[ 100 ]; - double K[ 100 ]; - double n[ 100 ]; + int32_t N[ 100 ]; + int32_t K[ 100 ]; + int32_t n[ 100 ]; double x[ 100 ]; - double pmf; + double elapsed; + double y; double t; int i; for ( i = 0; i < 100; i++ ) { N[ i ] = stdlib_base_round( random_uniform( 1.0, 100.0 ) ); - K[ i ] = stdlib_base_round( random_uniform( 0.0, N[ i ] ) ); - n[ i ] = stdlib_base_round( random_uniform( 0.0, N[ i ] ) ); - x[ i ] = stdlib_base_round( random_uniform( 0.0, n[ i ] ) ); + K[ i ] = stdlib_base_round( random_uniform( 1.0, N[ i ] ) ); + n[ i ] = stdlib_base_round( random_uniform( 1.0, N[ i ] ) ); + x[ i ] = stdlib_base_round( random_uniform( 1.0, 10.0 ) ); } t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - pmf = stdlib_base_dists_hypergeometric_pmf( x[ i % 100 ], N[ i % 100 ], K[ i % 100 ], n[ i % 100 ] ); - if ( pmf != pmf ) { + y = stdlib_base_dists_hypergeometric_pmf( x[ i%100 ], N[ i%100 ], K[ i%100 ], n[ i%100 ] ); + if ( y != y ) { printf( "should not return NaN\n" ); break; } } elapsed = tic() - t; - if ( pmf != pmf ) { + if ( y != y ) { printf( "should not return NaN\n" ); } return elapsed; diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c index be22038edb07..19e59438d0c4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/examples/c/example.c @@ -16,10 +16,11 @@ * limitations under the License. */ -#include "stdlib/math/base/special/round.h" #include "stdlib/stats/base/dists/hypergeometric/pmf.h" -#include +#include "stdlib/math/base/special/round.h" #include +#include +#include static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); @@ -27,19 +28,19 @@ static double random_uniform( const double min, const double max ) { } int main( void ) { - double pmf; - double N; - double K; - double n; + int32_t N; + int32_t K; + int32_t n; + double y; double x; int i; for ( i = 0; i < 10; i++ ) { + x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); N = stdlib_base_round( random_uniform( 0.0, 20.0 ) ); K = stdlib_base_round( random_uniform( 0.0, N ) ); n = stdlib_base_round( random_uniform( 0.0, N ) ); - x = stdlib_base_round( random_uniform( 0.0, 5.0 ) ); - pmf = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); - printf( "x: %lf, N: %lf, K: %lf, n: %lf, P(X=x;N,K,n): %lf\n", x, N, K, n, pmf ); + y = stdlib_base_dists_hypergeometric_pmf( x, N, K, n ); + printf( "x: %lf, N: %d, K: %d, n: %d, P(X=x;N,K,n): %lf\n", x, N, K, n, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h index 31a6629f3be6..db95d11a6789 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/include/stdlib/stats/base/dists/hypergeometric/pmf.h @@ -19,6 +19,8 @@ #ifndef STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H #define STDLIB_STATS_BASE_DISTS_HYPERGEOMETRIC_PMF_H +#include + /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. */ @@ -28,14 +30,8 @@ extern "C" { /** * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. -* -* @param x input value -* @param N population size -* @param K subpopulation size -* @param n number of draws -* @return evaluated PMF */ -double stdlib_base_dists_hypergeometric_pmf( const double x, const double N, const double K, const double n ); +double stdlib_base_dists_hypergeometric_pmf( const double x, const int32_t N, const int32_t K, const int32_t n ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js index dc642acb31a1..5f5c36a242fb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js @@ -26,14 +26,13 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the probability mass function (PMF) for a hypergeometric distribution. +* Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. * -* @private -* @param {number} x - number of successes -* @param {number} N - population size -* @param {number} K - subpopulation size -* @param {number} n - number of draws -* @returns {number} evaluated PMF +* @param {number} x - input value +* @param {NonNegativeInteger} N - population size +* @param {NonNegativeInteger} K - subpopulation size +* @param {NonNegativeInteger} n - number of draws +* @returns {Probability} evaluated PMF * * @example * var y = pmf( 1.0, 8, 4, 2 ); @@ -52,31 +51,7 @@ var addon = require( './../src/addon.node' ); * // returns 0.0 * * @example -* var y = pmf( NaN, 10, 5, 2 ); -* // returns NaN -* -* @example -* var y = pmf( 0.0, NaN, 5, 2 ); -* // returns NaN -* -* @example -* var y = pmf( 0.0, 10, NaN, 2 ); -* // returns NaN -* -* @example -* var y = pmf( 0.0, 10, 5, NaN ); -* // returns NaN -* -* @example -* var y = pmf( 2.0, 10.5, 5, 2 ); -* // returns NaN -* -* @example -* var y = pmf( 2.0, 5, 1.5, 2 ); -* // returns NaN -* -* @example -* var y = pmf( 2.0, 10, 5, -2.0 ); +* var y = pmf( 2.0, 10, 5, -2 ); * // returns NaN * * @example diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json index 9b453b60fd6c..f9d810839f95 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json @@ -39,13 +39,11 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/napi/quaternary", - "@stdlib/math/base/assert/is-nonnegative-integer", - "@stdlib/constants/float64/pinf", - "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/special/exp", "@stdlib/math/base/special/factorialln", "@stdlib/math/base/special/max", - "@stdlib/math/base/special/min" + "@stdlib/math/base/special/min", + "@stdlib/math/base/assert/is-nonnegative-integer" ] }, { @@ -60,14 +58,12 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nonnegative-integer", - "@stdlib/constants/float64/pinf", - "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/special/exp", "@stdlib/math/base/special/factorialln", "@stdlib/math/base/special/max", "@stdlib/math/base/special/min", - "@stdlib/math/base/special/round" + "@stdlib/math/base/special/round", + "@stdlib/math/base/assert/is-nonnegative-integer" ] }, { @@ -82,14 +78,12 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nonnegative-integer", - "@stdlib/constants/float64/pinf", - "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/special/exp", "@stdlib/math/base/special/factorialln", "@stdlib/math/base/special/max", "@stdlib/math/base/special/min", - "@stdlib/math/base/special/round" + "@stdlib/math/base/special/round", + "@stdlib/math/base/assert/is-nonnegative-integer" ] } ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c index 5a80c214c776..d81a16349a27 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -48,12 +48,13 @@ double stdlib_base_dists_hypergeometric_pmf( const double x, const int32_t N, co return 0.0/0.0; // NaN } - mins = stdlib_base_max( 0, n + K - N ); + mins = stdlib_base_max( 0, n+K-N ); maxs = stdlib_base_min( K, n ); if ( stdlib_base_is_nonnegative_integer( x ) && mins <= x && x <= maxs ) { lnum = stdlib_base_factorialln( n ) + stdlib_base_factorialln( K ) + stdlib_base_factorialln( N-n ) + stdlib_base_factorialln( N-K ); - ldenom = stdlib_base_factorialln( N ) + stdlib_base_factorialln( x ) + stdlib_base_factorialln( n-x ) + stdlib_base_factorialln( K-x ) + stdlib_base_factorialln( N-K+x-n ); + ldenom = stdlib_base_factorialln( N ) + stdlib_base_factorialln( x ) + stdlib_base_factorialln( n-x ); + ldenom += stdlib_base_factorialln( K-x ) + stdlib_base_factorialln( N-K+x-n ); lpmf = lnum - ldenom; return stdlib_base_exp( lpmf ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index afb574d8fea1..14a90545dd95 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -25,8 +25,6 @@ var tape = require( 'tape' ); var tryRequire = require( '@stdlib/utils/try-require' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var abs = require( '@stdlib/math/base/special/abs' ); -var PINF = require( '@stdlib/constants/float64/pinf' ); -var NINF = require( '@stdlib/constants/float64/ninf' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -51,36 +49,18 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, function test( t ) { - var y = pmf( NaN, 10, 10, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, NaN, 10, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, 10, NaN, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, 10, 10, NaN ); - t.equal( isnan( y ), true, 'returns NaN' ); - t.end(); -}); - tape( 'if provided an integer `x` greater than `min( n, K )`, the function returns `0` (provided all parameters are valid)', opts, function test( t ) { - var y = pmf( PINF, 20, 20, 10 ); + var y = pmf( 11.0, 20, 20, 10 ); t.equal( y, 0.0, 'returns 0' ); - y = pmf( 11, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); - - y = pmf( 100, 20, 20, 10 ); + y = pmf( 100.0, 20, 20, 10 ); t.equal( y, 0.0, 'returns 0' ); t.end(); }); tape( 'if provided an integer for `x` smaller than `max( 0, n + K - N )`, the function returns `0`', opts, function test( t ) { - var y = pmf( NINF, 40, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); - - y = pmf( -1.0, 40, 20, 10 ); + var y = pmf( -1.0, 40, 20, 10 ); t.equal( y, 0.0, 'returns 0' ); y = pmf( -2.0, 30, 20, 20 ); @@ -92,19 +72,10 @@ tape( 'if provided an integer for `x` smaller than `max( 0, n + K - N )`, the fu tape( 'if provided an `N` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { var y; - y = pmf( 2.0, 30.5, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, -2, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, -1, 20, 10 ); + y = pmf( 2.0, -20, 3, 10 ); t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, 20.5, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 0.0, PINF, 20, 10 ); + y = pmf( 2.0, -10, 3, 10 ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); @@ -113,19 +84,10 @@ tape( 'if provided an `N` which is not a nonnegative integer, the function retur tape( 'if provided a `K` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { var y; - y = pmf( 2.0, 20, 3.5, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, 20, -2, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, 20, -1, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 0.0, 20, 2.5, 10 ); + y = pmf( 2.0, 20, -3, 10 ); t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, 20, PINF, 10 ); + y = pmf( 2.0, 20, -10, 10 ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); @@ -134,19 +96,10 @@ tape( 'if provided a `K` which is not a nonnegative integer, the function return tape( 'if provided an `n` which is not a nonnegative integer, the function returns `NaN`', opts, function test( t ) { var y; - y = pmf( 2.0, 40, 20, 3.5 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, 40, 20, -2 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 2.0, 40, 20, -1 ); - t.equal( isnan( y ), true, 'returns NaN' ); - - y = pmf( 0.0, 40, 20, 2.5 ); + y = pmf( 2.0, 20, 3, -10 ); t.equal( isnan( y ), true, 'returns NaN' ); - y = pmf( 0.0, 40, 20, PINF ); + y = pmf( 2.0, 20, 3, -20 ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); From 64bdefbcbd0b90d8fa77206d413c760ecf089c3a Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 1 Mar 2025 14:49:59 -0800 Subject: [PATCH 16/20] fix: add @private to native.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js index 5f5c36a242fb..5b0c8e4a7c4b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Evaluates the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K`, and number of draws `n`. * +* @private * @param {number} x - input value * @param {NonNegativeInteger} N - population size * @param {NonNegativeInteger} K - subpopulation size From ff061305a2174d8cf4dcd287a6153219f79192bd Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 1 Mar 2025 15:13:30 -0800 Subject: [PATCH 17/20] test: update test messages --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- .../hypergeometric/pmf/test/test.factory.js | 56 +++++++++---------- .../hypergeometric/pmf/test/test.native.js | 20 +++---- .../dists/hypergeometric/pmf/test/test.pmf.js | 50 ++++++++--------- 3 files changed, 63 insertions(+), 63 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.factory.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.factory.js index 82909fe6dde7..9d4ee943015a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.factory.js @@ -54,35 +54,35 @@ tape( 'if provided `NaN` for any parameter, the created function returns `NaN`', pmf = factory( 40, 20, 10 ); y = pmf( NaN ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( NaN, 20, 10 ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, NaN, 10 ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, 10, NaN ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( NaN, NaN, 10 ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, NaN, NaN ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( NaN, 20, NaN ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( NaN, NaN, NaN ); y = pmf( NaN ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -93,13 +93,13 @@ tape( 'if provided valid parameters, the function returns a function which retur pmf = factory( 40, 20, 10 ); y = pmf( PINF ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 12.0 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 11.0 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); @@ -111,10 +111,10 @@ tape( 'if provided valid parameters, the function returns a function which retur pmf = factory( 40, 30, 15 ); y = pmf( 1.0 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 4.0 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); @@ -126,22 +126,22 @@ tape( 'if provided an `N` which is not a nonnegative integer, the created functi pmf = factory( 20.5, 20, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( -10, 20, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( PINF, 20, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( NINF, 20, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -153,22 +153,22 @@ tape( 'if provided a `K` which is not a nonnegative integer, the created functio pmf = factory( 40, 20.5, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, -10, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, PINF, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, NINF, 10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -180,22 +180,22 @@ tape( 'if provided an `n` which is not a nonnegative integer, the created functi pmf = factory( 40, 20, 10.5 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 40, 20, -10 ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 30, 20, PINF ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); pmf = factory( 30, 20, NINF ); y = pmf( 2.0 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index 14a90545dd95..a2958e6a2184 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -51,20 +51,20 @@ tape( 'main export is a function', opts, function test( t ) { tape( 'if provided an integer `x` greater than `min( n, K )`, the function returns `0` (provided all parameters are valid)', opts, function test( t ) { var y = pmf( 11.0, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 100.0, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); tape( 'if provided an integer for `x` smaller than `max( 0, n + K - N )`, the function returns `0`', opts, function test( t ) { var y = pmf( -1.0, 40, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( -2.0, 30, 20, 20 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); @@ -73,10 +73,10 @@ tape( 'if provided an `N` which is not a nonnegative integer, the function retur var y; y = pmf( 2.0, -20, 3, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, -10, 3, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -85,10 +85,10 @@ tape( 'if provided a `K` which is not a nonnegative integer, the function return var y; y = pmf( 2.0, 20, -3, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 20, -10, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -97,10 +97,10 @@ tape( 'if provided an `n` which is not a nonnegative integer, the function retur var y; y = pmf( 2.0, 20, 3, -10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 20, 3, -20 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.pmf.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.pmf.js index cb152319cfbd..486931be3f1f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.pmf.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.pmf.js @@ -44,38 +44,38 @@ tape( 'main export is a function', function test( t ) { tape( 'if provided `NaN` for any parameter, the function returns `NaN`', function test( t ) { var y = pmf( NaN, 10, 10, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, NaN, 10, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 10, NaN, 5 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 10, 10, NaN ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); tape( 'if provided an integer `x` greater than `min( n, K )`, the function returns `0` (provided all parameters are valid)', function test( t ) { var y = pmf( PINF, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 11, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( 100, 20, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); tape( 'if provided an integer for `x` smaller than `max( 0, n + K - N )`, the function returns `0`', function test( t ) { var y = pmf( NINF, 40, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( -1.0, 40, 20, 10 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); y = pmf( -2.0, 30, 20, 20 ); - t.equal( y, 0.0, 'returns 0' ); + t.equal( y, 0.0, 'returns expected value' ); t.end(); }); @@ -84,19 +84,19 @@ tape( 'if provided an `N` which is not a nonnegative integer, the function retur var y; y = pmf( 2.0, 30.5, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, -2, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, -1, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 20.5, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, PINF, 20, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -105,19 +105,19 @@ tape( 'if provided a `K` which is not a nonnegative integer, the function return var y; y = pmf( 2.0, 20, 3.5, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 20, -2, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 20, -1, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 20, 2.5, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 20, PINF, 10 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); @@ -126,19 +126,19 @@ tape( 'if provided an `n` which is not a nonnegative integer, the function retur var y; y = pmf( 2.0, 40, 20, 3.5 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 40, 20, -2 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 2.0, 40, 20, -1 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 40, 20, 2.5 ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); y = pmf( 0.0, 40, 20, PINF ); - t.equal( isnan( y ), true, 'returns NaN' ); + t.equal( isnan( y ), true, 'returns expected value' ); t.end(); }); From b7293516ea6fd431d6f50c1792de5dcfb7b8e883 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 1 Mar 2025 20:01:18 -0500 Subject: [PATCH 18/20] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/hypergeometric/pmf/README.md | 2 +- .../stats/base/dists/hypergeometric/pmf/test/test.native.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md index fde2705fa3d6..c2eb985829ed 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/README.md @@ -200,7 +200,7 @@ The function accepts the following arguments: - **n**: `[in] int32_t` number of draws. ```c -double stdlib_base_dists_hypergeometric_pmf ( const double x, const int32_t N, const int32_t K, const int32_t n ); +double stdlib_base_dists_hypergeometric_pmf( const double x, const int32_t N, const int32_t K, const int32_t n ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index a2958e6a2184..fd8954cea09b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -30,9 +30,9 @@ var EPS = require( '@stdlib/constants/float64/eps' ); // VARIABLES // -var pmf = tryRequire(resolve(__dirname, './../lib/native.js')); +var pmf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': (pmf instanceof Error) + 'skip': ( pmf instanceof Error ) }; From ad0e645d2621b066dd985b779d8a4e7e11b0f3bb Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 1 Mar 2025 17:05:49 -0800 Subject: [PATCH 19/20] chore: apply suggestions from review --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- .../stats/base/dists/hypergeometric/pmf/manifest.json | 9 ++++++--- .../stats/base/dists/hypergeometric/pmf/src/main.c | 3 ++- .../base/dists/hypergeometric/pmf/test/test.native.js | 6 ++++++ 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json index f9d810839f95..bd827c72eba1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/manifest.json @@ -43,7 +43,8 @@ "@stdlib/math/base/special/factorialln", "@stdlib/math/base/special/max", "@stdlib/math/base/special/min", - "@stdlib/math/base/assert/is-nonnegative-integer" + "@stdlib/math/base/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan" ] }, { @@ -63,7 +64,8 @@ "@stdlib/math/base/special/max", "@stdlib/math/base/special/min", "@stdlib/math/base/special/round", - "@stdlib/math/base/assert/is-nonnegative-integer" + "@stdlib/math/base/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan" ] }, { @@ -83,7 +85,8 @@ "@stdlib/math/base/special/max", "@stdlib/math/base/special/min", "@stdlib/math/base/special/round", - "@stdlib/math/base/assert/is-nonnegative-integer" + "@stdlib/math/base/assert/is-nonnegative-integer", + "@stdlib/math/base/assert/is-nan" ] } ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c index d81a16349a27..a131094db848 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/src/main.c @@ -18,6 +18,7 @@ #include "stdlib/stats/base/dists/hypergeometric/pmf.h" #include "stdlib/math/base/assert/is_nonnegative_integer.h" +#include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/special/factorialln.h" #include "stdlib/math/base/special/exp.h" #include "stdlib/math/base/special/max.h" @@ -44,7 +45,7 @@ double stdlib_base_dists_hypergeometric_pmf( const double x, const int32_t N, co double maxs; double mins; - if ( N < 0 || K < 0 || n < 0 || K > N || n > N ) { + if ( stdlib_base_is_nan( x ) || N < 0 || K < 0 || n < 0 || K > N || n > N ) { return 0.0/0.0; // NaN } diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index fd8954cea09b..e2d2f6f51bfb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -49,6 +49,12 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); +tape( 'if provided `NaN` for input value `x`, the function returns `NaN`', function test( t ) { + var y = pmf( NaN, 10, 10, 5 ); + t.equal( isnan( y ), true, 'returns expected value' ); + t.end(); +}); + tape( 'if provided an integer `x` greater than `min( n, K )`, the function returns `0` (provided all parameters are valid)', opts, function test( t ) { var y = pmf( 11.0, 20, 20, 10 ); t.equal( y, 0.0, 'returns expected value' ); From fbc88dd01df9f380ad40666e3135591119a11807 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 1 Mar 2025 17:07:29 -0800 Subject: [PATCH 20/20] chore: add missing opts --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- .../stats/base/dists/hypergeometric/pmf/test/test.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js index e2d2f6f51bfb..f3468885040e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/test/test.native.js @@ -49,7 +49,7 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'if provided `NaN` for input value `x`, the function returns `NaN`', function test( t ) { +tape( 'if provided `NaN` for input value `x`, the function returns `NaN`', opts, function test( t ) { var y = pmf( NaN, 10, 10, 5 ); t.equal( isnan( y ), true, 'returns expected value' ); t.end();