From 5374d17a529495e82fd490221e138188b2db8c3f Mon Sep 17 00:00:00 2001 From: Nishchay Rajput Date: Thu, 23 Jan 2025 14:06:07 +0530 Subject: [PATCH 1/6] feat: add C implementation for @stdlib/stats/base/dists/bernoulli/quantile --- 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: passed - 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: missing_dependencies - 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 --- --- .../base/dists/bernoulli/quantile/README.md | 98 ++++++++++ .../quantile/benchmark/benchmark.native.js | 70 ++++++++ .../bernoulli/quantile/benchmark/c/Makefile | 146 +++++++++++++++ .../quantile/benchmark/c/benchmark.c | 129 +++++++++++++ .../base/dists/bernoulli/quantile/binding.gyp | 170 ++++++++++++++++++ .../bernoulli/quantile/examples/c/Makefile | 146 +++++++++++++++ .../bernoulli/quantile/examples/c/example.c | 35 ++++ .../dists/bernoulli/quantile/include.gypi | 53 ++++++ .../stats/base/dists/bernoulli/quantile.h | 38 ++++ .../dists/bernoulli/quantile/lib/native.js | 75 ++++++++ .../dists/bernoulli/quantile/manifest.json | 76 ++++++++ .../dists/bernoulli/quantile/package.json | 3 + .../dists/bernoulli/quantile/src/Makefile | 70 ++++++++ .../base/dists/bernoulli/quantile/src/addon.c | 23 +++ .../base/dists/bernoulli/quantile/src/main.c | 48 +++++ .../bernoulli/quantile/test/test.native.js | 124 +++++++++++++ 16 files changed, 1304 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include/stdlib/stats/base/dists/bernoulli/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md index ed3daca7c5be..3d961a9c49ef 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md @@ -145,6 +145,104 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/bernoulli/quantile.h" +``` + +#### stdlib_base_dists_bernoulli_quantile( r, p ) + +Returns the [quantile][quantile-function] of a [Bernoulli][bernoulli-distribution] distribution with input value `r` and success probability `p`. + +```c +double out = stdlib_base_dists_bernoulli_quantile( 0.8, 0.4 ); +// returns 1 +``` + +The function accepts the following arguments: + +- **r**: `[in] double` input value. +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_bernoulli_quantile( const double r, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/bernoulli/quantile.h" +#include +#include + +int main( void ) { + double r; + double p; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + r = (double)rand() / ( (double)RAND_MAX + 1.0 ); + p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_bernoulli_quantile( r, p ); + printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/benchmark.native.js new file mode 100644 index 000000000000..305966da05e5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/benchmark.native.js @@ -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. +*/ + +'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 pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( quantile instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var p; + var r; + var y; + var i; + + len = 100; + r = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + r[ i ] = randu(); + p[ i ] = randu(); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = quantile( r[ 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/bernoulli/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/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/bernoulli/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c new file mode 100644 index 000000000000..e12ebce9e3fc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c @@ -0,0 +1,129 @@ +/** +* @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/bernoulli/quantile.h" +#include +#include +#include +#include +#include + +#define NAME "bernoulli-quantile" +#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 r[ 100 ]; + double p[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + + r[ i ] = (double)rand() / ( (double)RAND_MAX + 1.0 ); + p[ i ] = (double)rand() / ( (double)RAND_MAX + 1.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_bernoulli_quantile( r[ i % 100 ], p[ i % 100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%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/bernoulli/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/binding.gyp @@ -0,0 +1,170 @@ +# @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)', + ], + + # 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/bernoulli/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/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/bernoulli/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c new file mode 100644 index 000000000000..903f4949685a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c @@ -0,0 +1,35 @@ +/** +* @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/bernoulli/quantile.h" +#include +#include + +int main( void ) { + double r; + double p; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + r = (double)rand() / ( (double)RAND_MAX + 1.0 ); + p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_bernoulli_quantile( r, p ); + printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include.gypi @@ -0,0 +1,53 @@ +# @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': [ + ' 1.0 || + r < 0.0 || + r > 1.0 + ) { + return 0.0/0.0; // NaN + } + if( r <= 1.0 - p ) { + return 0.0; + } + return 1.0; +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js new file mode 100644 index 000000000000..cf258747b5a4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js @@ -0,0 +1,124 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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 tape = require( 'tape' ); +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' ); +var quantile = require( './../lib' ); + + +// FIXTURES // + +var smallP = require( './fixtures/julia/small_p.json' ); +var largeP = require( './fixtures/julia/large_p.json' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof quantile, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for any parameter, the function returns `NaN`', function test( t ) { + var y = quantile( NaN, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = quantile( 0.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided a number outside `[0,1]` for `r` and a valid `p`, the function returns `NaN`', function test( t ) { + var y = quantile( 2.2, 0.8 ); + t.equal( isnan( y ), true, 'returns true' ); + y = quantile( -0.2, 0.8 ); + t.equal( isnan( y ), true, 'returns true' ); + t.end(); +}); + +tape( 'if provided a success probability `p` outside `[0,1]`, the function returns `NaN`', function test( t ) { + var y; + + y = quantile( 0.8, 1.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.9, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.8, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function evaluates the quantile for `r` given small parameter `p`', function test( t ) { + var expected; + var delta; + var tol; + var r; + var p; + var y; + var i; + + expected = smallP.expected; + r = smallP.r; + p = smallP.p; + for ( i = 0; i < r.length; i++ ) { + y = quantile( r[i], p[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'r: '+r[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. r: '+r[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the quantile for `r` given large parameter `p`', function test( t ) { + var expected; + var delta; + var tol; + var r; + var p; + var y; + var i; + + expected = largeP.expected; + r = largeP.r; + p = largeP.p; + for ( i = 0; i < r.length; i++ ) { + y = quantile( r[i], p[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'r: '+r[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. r: '+r[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From 30fcf84556c798ca1f70530273c0e8ea0fe33f8f Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:02:04 -0500 Subject: [PATCH 2/6] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/bernoulli/quantile/README.md | 11 ++++++++--- .../dists/bernoulli/quantile/examples/c/example.c | 9 +++++++-- .../stats/base/dists/bernoulli/quantile/src/main.c | 4 ++-- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md index 3d961a9c49ef..56abe006a7cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md @@ -173,7 +173,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_bernoulli_quantile( r, p ) -Returns the [quantile][quantile-function] of a [Bernoulli][bernoulli-distribution] distribution with input value `r` and success probability `p`. +Evaluates the [quantile][quantile-function] of a [Bernoulli][bernoulli-distribution] distribution with input value `r` and success probability `p`. ```c double out = stdlib_base_dists_bernoulli_quantile( 0.8, 0.4 ); @@ -212,6 +212,11 @@ double stdlib_base_dists_bernoulli_quantile( const double r, const double p ); #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 r; double p; @@ -219,8 +224,8 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - r = (double)rand() / ( (double)RAND_MAX + 1.0 ); - p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + r = random_uniform( 0.0, 1.0 ); + p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_bernoulli_quantile( r, p ); printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c index 903f4949685a..bef4dcfa7654 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/examples/c/example.c @@ -20,6 +20,11 @@ #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 r; double p; @@ -27,8 +32,8 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - r = (double)rand() / ( (double)RAND_MAX + 1.0 ); - p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + r = random_uniform( 0.0, 1.0 ); + p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_bernoulli_quantile( r, p ); printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/main.c index 76737b452eb3..de7dc5f86add 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/src/main.c @@ -27,7 +27,7 @@ * @return evaluated quantile function * * @example -* double y = stdlib_base_bernoulli_quantile( 0.8, 0.4 ); +* double y = stdlib_base_dists_bernoulli_quantile( 0.8, 0.4 ); * // returns 1 */ double stdlib_base_dists_bernoulli_quantile( const double r, const double p ) { @@ -41,7 +41,7 @@ double stdlib_base_dists_bernoulli_quantile( const double r, const double p ) { ) { return 0.0/0.0; // NaN } - if( r <= 1.0 - p ) { + if ( r <= 1.0 - p ) { return 0.0; } return 1.0; From e6bacfaf8fa947eff565e4a36e83a222396ba312 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:03:24 -0500 Subject: [PATCH 3/6] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../bernoulli/quantile/benchmark/c/benchmark.c | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c index e12ebce9e3fc..ca87ae4b7b87 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/benchmark/c/benchmark.c @@ -74,6 +74,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. * @@ -88,9 +100,8 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - - r[ i ] = (double)rand() / ( (double)RAND_MAX + 1.0 ); - p[ i ] = (double)rand() / ( (double)RAND_MAX + 1.0 ); + r[ i ] = random_uniform( 0.0, 1.0 ); + p[ i ] = random_uniform( 0.0, 1.0 ); } t = tic(); From 02c2a3193dc6783fbfbbd3a6969b167cfdd989a2 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:03:54 -0500 Subject: [PATCH 4/6] chore: fix indentation --- .../dists/bernoulli/quantile/manifest.json | 146 +++++++++--------- 1 file changed, 73 insertions(+), 73 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/manifest.json index a41bb048033e..db80b71a4aa4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/manifest.json @@ -1,76 +1,76 @@ { - "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" + ] }, - "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" - ] - }, - { - "task": "examples", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan" - ] - } - ] - } + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan" + ] + } + ] +} From 380aa943fcac530240441f6ca5a74bfc945539d3 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:04:11 -0500 Subject: [PATCH 5/6] chore: update description Signed-off-by: Philipp Burckhardt --- .../include/stdlib/stats/base/dists/bernoulli/quantile.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include/stdlib/stats/base/dists/bernoulli/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include/stdlib/stats/base/dists/bernoulli/quantile.h index 6f3afa4de426..324a5284745d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include/stdlib/stats/base/dists/bernoulli/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/include/stdlib/stats/base/dists/bernoulli/quantile.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the Quantile of a Bernoulli distribution. +* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a probability `r`. */ double stdlib_base_dists_bernoulli_quantile( const double r, const double p ); From 98294c6cea9f4ea272c15bcb33d21edcee4f0bda Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 5 Mar 2025 03:06:15 +0000 Subject: [PATCH 6/6] chore: update copyright years --- .../stats/base/dists/bernoulli/quantile/test/test.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js index cf258747b5a4..dba5bf732cfb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 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.