From a30a83b552472ba1410fd486d9592ebacd4ca289 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Thu, 12 Dec 2024 19:29:48 +0530 Subject: [PATCH 1/6] feat: add C implementation for stdlib/stats/base/dists/binomial/mean --- .../stats/base/dists/binomial/mean/README.md | 86 +++++++++ .../mean/benchmark/benchmark.native.js | 71 ++++++++ .../dists/binomial/mean/benchmark/c/Makefile | 146 +++++++++++++++ .../binomial/mean/benchmark/c/benchmark.c | 124 +++++++++++++ .../base/dists/binomial/mean/binding.gyp | 170 ++++++++++++++++++ .../dists/binomial/mean/examples/c/Makefile | 146 +++++++++++++++ .../dists/binomial/mean/examples/c/example.c | 34 ++++ .../base/dists/binomial/mean/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/binomial/mean.h | 38 ++++ .../base/dists/binomial/mean/lib/native.js | 62 +++++++ .../base/dists/binomial/mean/manifest.json | 76 ++++++++ .../base/dists/binomial/mean/package.json | 3 + .../base/dists/binomial/mean/src/Makefile | 70 ++++++++ .../base/dists/binomial/mean/src/addon.c | 23 +++ .../stats/base/dists/binomial/mean/src/main.c | 48 +++++ .../dists/binomial/mean/test/test.native.js | 110 ++++++++++++ 16 files changed, 1260 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include/stdlib/stats/base/dists/binomial/mean.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md index e8d6be031166..6047b0750dcd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md @@ -149,6 +149,92 @@ for ( i = 0; i < 10; i++ ) { + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/binomial/mean.h" +``` + +#### stdlib_base_dists_binomial_mean( n, p ) + +Returns the [expected value][expected-value] of a [Binomial][binomial-distribution] distribution with number of trials `n` and success probability `p`. + +```c +double out = stdlib_base_dists_binomial_mean( 10, 0.1 ); +// returns ~1.0 +``` + +The function accepts the following arguments: + +- **n**: `[in] int` number of trials +- **p**: `[in] double` success probability + +```c +double stdlib_base_dists_binomial_mean( const int n, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/binomial/mean.h" +#include +#include +int main( void ) { + int n; + double p; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + n = rand() % 20 + 1; // random number of trials between 1 and 20 + p = ( (double)rand() / (double)RAND_MAX ); // random probability between 0 and 1 + y = stdlib_base_dists_binomial_mean( n, p ); + printf( "n: %d, p: %lf, E(X;n,p): %lf\n", n, p, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js new file mode 100644 index 000000000000..550975b07d7d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var floor = require( '@stdlib/math/base/special/floor' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var mean = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( mean instanceof Error ) +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var len; + var n; + var p; + var y; + var i; + + len = 100; + n = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + n[ i ] = floor( randu() * 100.0 ); // Random trials between 0 and 100 + p[ i ] = randu(); // Random probability between 0 and 1 + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = mean( n[ i % len ], p[ 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/binomial/mean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile new file mode 100644 index 000000000000..0ebf4545e1a9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := 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 \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c new file mode 100644 index 000000000000..97ebb6332e9a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c @@ -0,0 +1,124 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/binomial/mean.h" +#include +#include +#include +#include +#include + +#define NAME "binomial-mean" +#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; +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double p, n; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + p = ( (double)rand() / (double)RAND_MAX ); + n = (double)( rand() % 100 + 1 ); // Random number of trials between 1 and 100 + y = stdlib_base_dists_binomial_mean( n, p ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%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/binomial/mean/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp new file mode 100644 index 000000000000..507cb00291e7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile new file mode 100644 index 000000000000..d53ef397c77d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c new file mode 100644 index 000000000000..47a61d46f9c3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/binomial/mean.h" +#include +#include + +int main( void ) { + double p, n; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = ( (double)rand() / (double)RAND_MAX ); + n = (double)( rand() % 100 + 1 ); // Random number of trials between 1 and 100 + y = stdlib_base_dists_binomial_mean( n, p ); + printf( "n: %lf, p: %lf, H(X;n,p): %lf\n", n, p, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi new file mode 100644 index 000000000000..c6495fc1da3f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' 1.0 + ) { + return 0.0 / 0.0; + } + return n * p; +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js new file mode 100644 index 000000000000..630ea81d7766 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js @@ -0,0 +1,110 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var 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' ); + + +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + +// VARIABLES // + +var mean = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( mean instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof mean, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for `n` or `p`, the function returns `NaN`', opts, function test( t ) { + var v; + + v = mean( NaN, 0.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = mean( 10, NaN ); + t.equal( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided `n < 0` or success probability `p` outside of `[0,1]`, the function returns `NaN`', opts, function test( t ) { + var v; + + v = mean( -1, 0.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = mean( 10, -0.1 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = mean( 10, 1.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = mean( NINF, 0.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = mean( PINF, 0.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns the mean of a Binomial distribution', opts, function test( t ) { + var expected; + var delta; + var tol; + var i; + var n; + var p; + var y; + + expected = data.expected; + n = data.n; + p = data.p; + for ( i = 0; i < expected.length; i++ ) { + y = mean( n[i], p[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'n: '+n[i]+', p: '+p[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. n: '+n[i]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From e71cc1bb1c666d0e792c53b45e729d05b58940b3 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Thu, 12 Dec 2024 20:53:23 +0530 Subject: [PATCH 2/6] fix: resolved issue failed in javascript --- .../@stdlib/stats/base/dists/binomial/mean/manifest.json | 1 + .../@stdlib/stats/base/dists/binomial/mean/src/addon.c | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json index 1ddd78773f49..d8259fbfab10 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json @@ -38,6 +38,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/math/base/napi/binary", "@stdlib/math/base/napi/unary", "@stdlib/math/base/assert/is-nan" ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c index 2392a4db80c9..8b9a55a91f53 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c @@ -17,7 +17,7 @@ */ #include "stdlib/stats/base/dists/binomial/mean.h" -#include "stdlib/math/base/napi/ternary.h" +#include "stdlib/math/base/napi/binary.h" // cppcheck-suppress shadowFunction -STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( stdlib_base_dists_binomial_mean ) +STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_binomial_mean ) From 14e6ca98b9a7854878cdec04db8d18c498ecf844 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Thu, 12 Dec 2024 21:13:26 +0530 Subject: [PATCH 3/6] fix: remove unwanted test --- .../stats/base/dists/binomial/mean/test/test.native.js | 4 ---- 1 file changed, 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js index 630ea81d7766..d1d005b5e856 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js @@ -25,7 +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' ); @@ -78,9 +77,6 @@ tape( 'if provided `n < 0` or success probability `p` outside of `[0,1]`, the fu v = mean( NINF, 0.5 ); t.equal( isnan( v ), true, 'returns NaN' ); - v = mean( PINF, 0.5 ); - t.equal( isnan( v ), true, 'returns NaN' ); - t.end(); }); From 745f57baebe283d9a4f47d2dd51f5758f2954eb7 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Mon, 6 Jan 2025 17:20:49 +0530 Subject: [PATCH 4/6] feat: added new implementation and other minor updates --- .../stats/base/dists/binomial/mean/README.md | 27 ++++++++++----- .../binomial/mean/benchmark/benchmark.js | 15 ++++++-- .../mean/benchmark/benchmark.native.js | 15 ++++---- .../dists/binomial/mean/benchmark/c/Makefile | 4 +-- .../binomial/mean/benchmark/c/benchmark.c | 34 ++++++++++++++----- .../base/dists/binomial/mean/binding.gyp | 4 +-- .../dists/binomial/mean/examples/c/Makefile | 4 +-- .../dists/binomial/mean/examples/c/example.c | 20 ++++++++--- .../base/dists/binomial/mean/include.gypi | 4 +-- .../stdlib/stats/base/dists/binomial/mean.h | 8 +++-- .../base/dists/binomial/mean/lib/native.js | 19 +++++------ .../base/dists/binomial/mean/manifest.json | 9 ++--- .../base/dists/binomial/mean/src/Makefile | 4 +-- .../base/dists/binomial/mean/src/addon.c | 4 +-- .../stats/base/dists/binomial/mean/src/main.c | 14 +++----- .../dists/binomial/mean/test/test.native.js | 11 ++---- 16 files changed, 117 insertions(+), 79 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md index 6047b0750dcd..25e860fbce7a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md @@ -175,20 +175,20 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_binomial_mean( n, p ) -Returns the [expected value][expected-value] of a [Binomial][binomial-distribution] distribution with number of trials `n` and success probability `p`. +Returns the [expected value][expected-value] of a [binomial][binomial-distribution] distribution with number of trials `n` and success probability `p`. ```c -double out = stdlib_base_dists_binomial_mean( 10, 0.1 ); -// returns ~1.0 +double out = stdlib_base_dists_binomial_mean( 100, 0.1 ); +// returns 10.0 ``` The function accepts the following arguments: -- **n**: `[in] int` number of trials +- **n**: `[in] int32_t` number of trials - **p**: `[in] double` success probability ```c -double stdlib_base_dists_binomial_mean( const int n, const double p ); +double stdlib_base_dists_binomial_mean( const int32_t n, const double p ); ```
@@ -211,19 +211,30 @@ double stdlib_base_dists_binomial_mean( const int n, const double p ); ```c #include "stdlib/stats/base/dists/binomial/mean.h" +#include "stdlib/math/base/special/ceil.h" #include +#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 ) { - int n; + int32_t n; double p; double y; int i; + for ( i = 0; i < 25; i++ ) { - n = rand() % 20 + 1; // random number of trials between 1 and 20 - p = ( (double)rand() / (double)RAND_MAX ); // random probability between 0 and 1 + n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) ); + p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_binomial_mean( n, p ); printf( "n: %d, p: %lf, E(X;n,p): %lf\n", n, p, y ); } + + return 0; } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.js index 9aade74b6382..83d7c663f8fe 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.js @@ -22,6 +22,8 @@ var bench = require( '@stdlib/bench' ); var ceil = require( '@stdlib/math/base/special/ceil' ); +var Int32Array = require( '@stdlib/array/int32' ); +var Float64Array = require( '@stdlib/array/float64' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; @@ -31,16 +33,23 @@ var mean = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var n; var p; var y; var i; + len = 100; + n = new Int32Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + n[ i ] = ceil( randu() * 100.0 ); + p[ i ] = randu(); + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - n = ceil( randu()*100.0 ); - p = randu(); - y = mean( n, p ); + y = mean( n[ i%len ], p[ i%len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js index 550975b07d7d..e5b39f95c4fd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -22,11 +22,12 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); +var Int32Array = require( '@stdlib/array/int32' ); var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var ceil = require( '@stdlib/math/base/special/ceil' ); var randu = require( '@stdlib/random/base/randu' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg, opts, function benchmark( b ) { +bench( pkg+'::native', opts, function benchmark( b ) { var len; var n; var p; @@ -48,11 +49,11 @@ bench( pkg, opts, function benchmark( b ) { var i; len = 100; - n = new Float64Array( len ); + n = new Int32Array( len ); p = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - n[ i ] = floor( randu() * 100.0 ); // Random trials between 0 and 100 - p[ i ] = randu(); // Random probability between 0 and 1 + n[ i ] = ceil( randu() * 100.0 ); + p[ i ] = randu(); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile index 0ebf4545e1a9..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. @@ -143,4 +143,4 @@ run: $(c_targets) clean: $(QUIET) -rm -f *.o *.out -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c index 97ebb6332e9a..82ce0544bc3a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -17,7 +17,9 @@ */ #include "stdlib/stats/base/dists/binomial/mean.h" +#include "stdlib/math/base/special/ceil.h" #include +#include #include #include #include @@ -37,8 +39,8 @@ static void print_version( void ) { /** * Prints the TAP summary. * -* @param total total number of tests -* @param passing total number of passing tests +* @param total total number of tests +* @param passing total number of passing tests */ static void print_summary( int total, int passing ) { printf( "#\n" ); @@ -52,7 +54,7 @@ static void print_summary( int total, int passing ) { /** * Prints benchmarks results. * -* @param elapsed elapsed time in seconds +* @param elapsed elapsed time in seconds */ static void print_results( double elapsed ) { double rate = (double)ITERATIONS / elapsed; @@ -74,6 +76,18 @@ static double tic( void ) { 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. * @@ -81,16 +95,20 @@ static double tic( void ) { */ static double benchmark( void ) { double elapsed; - double p, n; + int32_t n[ 100 ]; + double p[ 100 ]; double y; double t; int i; + for ( i = 0; i < 100; i++ ) { + n[ i ] = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) ); + p[ i ] = random_uniform( 0.0, 1.0 ); + } + t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ); - n = (double)( rand() % 100 + 1 ); // Random number of trials between 1 and 100 - y = stdlib_base_dists_binomial_mean( n, p ); + y = stdlib_base_dists_binomial_mean( n[ i % 100 ], p[ i % 100 ] ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp index 507cb00291e7..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/binding.gyp @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. @@ -167,4 +167,4 @@ ], # end actions }, # end target copy_addon ], # end targets -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile index d53ef397c77d..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. @@ -143,4 +143,4 @@ run: $(c_targets) clean: $(QUIET) -rm -f *.o *.out -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c index 47a61d46f9c3..a4b5ecef3b30 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -17,18 +17,28 @@ */ #include "stdlib/stats/base/dists/binomial/mean.h" +#include "stdlib/math/base/special/ceil.h" #include +#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 p, n; + int32_t n; + double p; double y; int i; for ( i = 0; i < 25; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ); - n = (double)( rand() % 100 + 1 ); // Random number of trials between 1 and 100 + n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) ); + p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_binomial_mean( n, p ); - printf( "n: %lf, p: %lf, H(X;n,p): %lf\n", n, p, y ); + printf( "n: %d, p: %lf, E(X;n,p): %lf\n", n, p, y ); } + + return 0; } diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi index c6495fc1da3f..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/include.gypi @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. @@ -50,4 +50,4 @@ ' + /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. */ @@ -27,9 +29,9 @@ extern "C" { #endif /** -* Returns the mean of a Binomial distribution. +* Returns the expected value of a binomial distribution with number of trials `n` and success probability `p`. */ -double stdlib_base_dists_binomial_mean( const double n, const double p ); +double stdlib_base_dists_binomial_mean( const int32_t n, const double p ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/lib/native.js index e036d91ce700..b77ed69c7b1d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -26,30 +26,27 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Returns the expected value of a Binomial distribution. +* Returns the expected value of a binomial distribution with number of trials `n` and success probability `p`. * -* @param {PositiveInteger} n - number of trials +* @private +* @param {NonNegativeInteger} n - number of trials * @param {Probability} p - success probability * @returns {PositiveNumber} expected value * * @example -* var v = mean( 10, 0.1 ); -* // returns 1.0 +* var v = mean( 100, 0.1 ); +* // returns 10.0 * * @example * var v = mean( 20, 0.5 ); * // returns 10.0 * * @example -* var v = mean( 10, 1.1 ); -* // returns NaN -* -* @example -* var v = mean( NaN, 0.5 ); +* var v = mean( 20, 1.1 ); * // returns NaN * * @example -* var v = mean( 10, NaN ); +* var v = mean( 20, NaN ); * // returns NaN */ function mean( n, p ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json index d8259fbfab10..3d4d216e274a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json @@ -39,7 +39,6 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/napi/binary", - "@stdlib/math/base/napi/unary", "@stdlib/math/base/assert/is-nan" ] }, @@ -55,7 +54,8 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan" + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/ceil" ] }, { @@ -70,8 +70,9 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan" + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/ceil" ] } ] - } \ No newline at end of file + } diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/Makefile index 81bb164286c3..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. @@ -67,4 +67,4 @@ clean-addon: #/ clean: clean-addon -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c index 8b9a55a91f53..112a3b225d7c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -20,4 +20,4 @@ #include "stdlib/math/base/napi/binary.h" // cppcheck-suppress shadowFunction -STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_binomial_mean ) +STDLIB_MATH_BASE_NAPI_MODULE_ID_D( stdlib_base_dists_binomial_mean ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c index 48948d18cb5c..18a6f97cba54 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -18,6 +18,7 @@ #include "stdlib/stats/base/dists/binomial/mean.h" #include "stdlib/math/base/assert/is_nan.h" +#include /** * Returns the expected value of a Binomial distribution. @@ -27,18 +28,13 @@ * @return expected value * * @example -* double y = stdlib_base_dists_binomial_mean( 10, 0.1 ); -* // returns 1.0 -* -* @example -* double y = stdlib_base_dists_binomial_mean( 20, 0.5 ); +* double y = stdlib_base_dists_binomial_mean( 100, 0.1 ); * // returns 10.0 */ -double stdlib_base_dists_binomial_mean( const double n, const double p ) { +double stdlib_base_dists_binomial_mean( const int32_t n, const double p ) { if ( - stdlib_base_is_nan( n ) || stdlib_base_is_nan( p ) || - n < 0.0 || + n < 0 || p < 0.0 || p > 1.0 ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js index d1d005b5e856..9ec73159b932 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -25,7 +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 NINF = require( '@stdlib/constants/float64/ninf' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -50,12 +49,9 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'if provided `NaN` for `n` or `p`, the function returns `NaN`', opts, function test( t ) { +tape( 'if provided `NaN` for `p`, the function returns `NaN`', opts, function test( t ) { var v; - v = mean( NaN, 0.5 ); - t.equal( isnan( v ), true, 'returns NaN' ); - v = mean( 10, NaN ); t.equal( isnan( v ), true, 'returns NaN' ); @@ -74,9 +70,6 @@ tape( 'if provided `n < 0` or success probability `p` outside of `[0,1]`, the fu v = mean( 10, 1.5 ); t.equal( isnan( v ), true, 'returns NaN' ); - v = mean( NINF, 0.5 ); - t.equal( isnan( v ), true, 'returns NaN' ); - t.end(); }); From b5fc70403ba7bfc8b1bceff608d84f0780f78507 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 8 Feb 2025 12:41:09 -0500 Subject: [PATCH 5/6] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/binomial/mean/README.md | 4 ++-- .../@stdlib/stats/base/dists/binomial/mean/src/main.c | 2 +- .../stats/base/dists/binomial/mean/test/test.native.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md index 25e860fbce7a..9bb82190dcd3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md @@ -184,8 +184,8 @@ double out = stdlib_base_dists_binomial_mean( 100, 0.1 ); The function accepts the following arguments: -- **n**: `[in] int32_t` number of trials -- **p**: `[in] double` success probability +- **n**: `[in] int32_t` number of trials. +- **p**: `[in] double` success probability. ```c double stdlib_base_dists_binomial_mean( const int32_t n, const double p ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c index 18a6f97cba54..efdd2cf49020 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/src/main.c @@ -21,7 +21,7 @@ #include /** -* Returns the expected value of a Binomial distribution. +* Returns the expected value of a binomial distribution. * * @param n number of trials * @param p success probability diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js index 9ec73159b932..cb74973eaefc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/test/test.native.js @@ -73,7 +73,7 @@ tape( 'if provided `n < 0` or success probability `p` outside of `[0,1]`, the fu t.end(); }); -tape( 'the function returns the mean of a Binomial distribution', opts, function test( t ) { +tape( 'the function returns the mean of a binomial distribution', opts, function test( t ) { var expected; var delta; var tol; From b937ca7545afaea5bb91a639d5d1f6004739f982 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 8 Feb 2025 12:42:04 -0500 Subject: [PATCH 6/6] chore: fix indentation --- .../base/dists/binomial/mean/manifest.json | 150 +++++++++--------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json index 3d4d216e274a..8fdec36f8cfa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/manifest.json @@ -1,78 +1,78 @@ { - "options": { + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { "task": "build", - "wasm": false + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/binary", + "@stdlib/math/base/assert/is-nan" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/ceil" + ] }, - "fields": [ - { - "field": "src", - "resolve": true, - "relative": true - }, - { - "field": "include", - "resolve": true, - "relative": true - }, - { - "field": "libraries", - "resolve": false, - "relative": false - }, - { - "field": "libpath", - "resolve": true, - "relative": false - } - ], - "confs": [ - { - "task": "build", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/napi/binary", - "@stdlib/math/base/assert/is-nan" - ] - }, - { - "task": "benchmark", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/ceil" - ] - }, - { - "task": "examples", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/ceil" - ] - } - ] - } + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/ceil" + ] + } + ] +}