From e9a6a9b80cbfc3c79a6c3f9ab3c7b15599e1d4f4 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sun, 22 Dec 2024 20:23:34 +0530 Subject: [PATCH 1/4] feat: add C implementation for exponential quantile --- .../base/dists/exponential/quantile/README.md | 99 ++++++++++ .../quantile/benchmark/benchmark.js | 14 +- .../quantile/benchmark/benchmark.native.js | 71 ++++++++ .../exponential/quantile/benchmark/c/Makefile | 146 +++++++++++++++ .../quantile/benchmark/c/benchmark.c | 141 +++++++++++++++ .../dists/exponential/quantile/binding.gyp | 170 ++++++++++++++++++ .../exponential/quantile/examples/c/Makefile | 146 +++++++++++++++ .../exponential/quantile/examples/c/example.c | 40 +++++ .../dists/exponential/quantile/include.gypi | 53 ++++++ .../stats/base/dists/exponential/quantile.h | 38 ++++ .../dists/exponential/quantile/lib/native.js | 72 ++++++++ .../dists/exponential/quantile/manifest.json | 83 +++++++++ .../dists/exponential/quantile/package.json | 3 + .../dists/exponential/quantile/src/Makefile | 70 ++++++++ .../dists/exponential/quantile/src/addon.c | 23 +++ .../dists/exponential/quantile/src/main.c | 46 +++++ .../exponential/quantile/test/test.native.js | 135 ++++++++++++++ 17 files changed, 1347 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md index fd5d5647b64f..baaf44fc8901 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md @@ -137,6 +137,105 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/exponential/quantile.h" +``` + +#### stdlib_base_dists_exponential_quantile( p, lambda ) + +Returns a function for evaluating the [quantile function][quantile-function] of an [exponential][exponential-distribution] distribution with rate parameter `lambda`. + +```c +double out = stdlib_base_dists_exponential_quantile( 0.8, 1.0 ); +// returns ~1.609 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` probability +- **lambda**: `[in] double` rate parameter. + +```c +double stdlib_base_dists_exponential_quantile( const double p, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/exponential/quantile.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double lambda; + double y; + double p; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + lambda = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_exponential_quantile( p, lambda ); + printf( "p: %lf, λ: %lf, Q[p;λ]: %lf\n", p, lambda, y ); + } +} +``` + +
+ + + + + +
+ +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.js index 45b8b5a04ca0..41889f7a1a11 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.js @@ -21,6 +21,7 @@ // MODULES // 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 EPS = require( '@stdlib/constants/float64/eps' ); @@ -32,15 +33,22 @@ var quantile = require( './../lib' ); bench( pkg, function benchmark( b ) { var lambda; + var len; var p; var y; var i; + len = 100; + p = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = ( randu() * 1.0 ) + EPS; + lambda[ i ] = ( randu() * 20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - p = randu(); - lambda = ( randu()*100.0 ) + EPS; - y = quantile( p, lambda ); + y = quantile( p[ i % 100 ], lambda[ i % 100 ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js new file mode 100644 index 000000000000..78ab9aa17646 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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 tryRequire = require( '@stdlib/utils/try-require' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +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 lambda; + var len; + var p; + var y; + var i; + + len = 100; + p = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = ( randu() * 1.0 ) + EPS; + lambda[ i ] = ( randu() * 20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = quantile( p[ i % 100 ], lambda[ 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/exponential/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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 diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c new file mode 100644 index 000000000000..d1cad2a6e300 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c @@ -0,0 +1,141 @@ +/** +* @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/exponential/quantile.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "exponential-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 benchmark results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double lambda[ 100 ]; + double y; + double p[ 100 ]; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + p[ i ] = random_uniform( 0.0, 1.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + lambda[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_exponential_quantile( p[ i % 100 ], lambda[ 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/exponential/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c new file mode 100644 index 000000000000..f6c165bca71b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c @@ -0,0 +1,40 @@ +/** +* @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/exponential/quantile.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double lambda; + double y; + double p; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + lambda = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_exponential_quantile( p, lambda ); + printf( "p: %lf, λ: %lf, Q[p;λ]: %lf\n", p, lambda, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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; // NaN + } + return -stdlib_base_ln( 1.0 - p ) / lambda; +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js new file mode 100644 index 000000000000..534655416a0c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js @@ -0,0 +1,135 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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' ); + + +// VARIABLES // + +var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( quantile instanceof Error ) +}; + + +// FIXTURES // + +var data = require( './fixtures/r/data.json' ); +var i; +for ( i = 0; i < data.expected.length; i++ ) { + if ( data.expected[ i ] === 'Inf' ) { + data.expected[ i ] = PINF; + } + if ( data.expected[ i ] === '-Inf' ) { + data.expected[ i ] = NINF; + } +} + + +// TESTS // + +tape( 'main export is a function', opts, 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`', opts, 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 `p` and a finite `lambda`, the function returns `NaN`', function test( t ) { + var y = quantile( 2.2, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + y = quantile( -0.2, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + t.end(); +}); + +tape( 'if provided `+infinity` for `lambda`, the function returns `NaN`', function test( t ) { + var y; + + y = quantile( 0.0, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( NaN, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( PINF, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( NINF, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided a negative `lambda`, the function always returns `NaN`', function test( t ) { + var y; + + y = quantile( 2.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 2.0, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function evaluates the quantile for `x` given parameter `lambda`', function test( t ) { + var expected; + var lambda; + var delta; + var tol; + var x; + var y; + var i; + + expected = data.expected; + x = data.x; + lambda = data.lambda; + for ( i = 0; i < x.length; i++ ) { + y = quantile( x[i], lambda[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', lambda: '+lambda[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 110.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. lambda: '+lambda[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From b97746c3a51d2c3da896271b0938d8ca1e1b27ac Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sun, 9 Feb 2025 01:09:01 +0000 Subject: [PATCH 2/4] chore: update copyright years --- .../dists/exponential/quantile/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/exponential/quantile/benchmark/c/Makefile | 2 +- .../base/dists/exponential/quantile/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/binding.gyp | 2 +- .../stats/base/dists/exponential/quantile/examples/c/Makefile | 2 +- .../stats/base/dists/exponential/quantile/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/include.gypi | 2 +- .../include/stdlib/stats/base/dists/exponential/quantile.h | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/lib/native.js | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/src/Makefile | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/src/addon.c | 2 +- .../@stdlib/stats/base/dists/exponential/quantile/src/main.c | 2 +- .../stats/base/dists/exponential/quantile/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js index 78ab9aa17646..89df60946745 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c index d1cad2a6e300..59d4c8467097 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c index f6c165bca71b..95ef8be32ec2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h index 47b0fc1071e2..144475c110f5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h @@ -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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/lib/native.js index a6a734056eac..ddde09a678aa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/addon.c index 12f7d6b7465a..e0f7f5ad0602 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c index 2263b97abcb2..194173dd782f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js index 534655416a0c..1149edf6c889 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/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. From aab8693d38743eceba50286d51f97c9d45ec1df4 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Fri, 14 Feb 2025 22:51:53 -0500 Subject: [PATCH 3/4] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/exponential/quantile/README.md | 6 +++--- .../exponential/quantile/benchmark/benchmark.native.js | 4 ++-- .../base/dists/exponential/quantile/benchmark/c/benchmark.c | 4 ++-- .../base/dists/exponential/quantile/examples/c/example.c | 2 +- .../include/stdlib/stats/base/dists/exponential/quantile.h | 2 +- .../stats/base/dists/exponential/quantile/src/main.c | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md index baaf44fc8901..0b214f33236f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/README.md @@ -165,7 +165,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_exponential_quantile( p, lambda ) -Returns a function for evaluating the [quantile function][quantile-function] of an [exponential][exponential-distribution] distribution with rate parameter `lambda`. +Evaluates the [quantile function][quantile-function] for a [exponential][exponential-distribution] distribution with rate parameter `lambda`. ```c double out = stdlib_base_dists_exponential_quantile( 0.8, 1.0 ); @@ -174,7 +174,7 @@ double out = stdlib_base_dists_exponential_quantile( 0.8, 1.0 ); The function accepts the following arguments: -- **p**: `[in] double` probability +- **p**: `[in] double` probability. - **lambda**: `[in] double` rate parameter. ```c @@ -219,7 +219,7 @@ int main( void ) { p = random_uniform( 0.0, 1.0 ); lambda = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_exponential_quantile( p, lambda ); - printf( "p: %lf, λ: %lf, Q[p;λ]: %lf\n", p, lambda, y ); + printf( "p: %lf, λ: %lf, Q(p;λ): %lf\n", p, lambda, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js index 89df60946745..d82487a20bad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js @@ -51,8 +51,8 @@ bench( pkg+'::native', opts, function benchmark( b ) { p = new Float64Array( len ); lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - p[ i ] = ( randu() * 1.0 ) + EPS; - lambda[ i ] = ( randu() * 20.0 ) + EPS; + p[ i ] = uniform( EPS, 1.0 ); + lambda[ i ] = uniform( EPS, 20.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c index 59d4c8467097..395733c10caf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/c/benchmark.c @@ -101,8 +101,8 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - p[ i ] = random_uniform( 0.0, 1.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; - lambda[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + p[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 1.0 ); + lambda[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c index 95ef8be32ec2..97d42cba6edd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/examples/c/example.c @@ -35,6 +35,6 @@ int main( void ) { p = random_uniform( 0.0, 1.0 ); lambda = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_exponential_quantile( p, lambda ); - printf( "p: %lf, λ: %lf, Q[p;λ]: %lf\n", p, lambda, y ); + printf( "p: %lf, λ: %lf, Q(p;λ): %lf\n", p, lambda, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h index 144475c110f5..bd505c1ed9e3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/include/stdlib/stats/base/dists/exponential/quantile.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the quantile of an exponential distribution. +* Evaluates the quantile function for an exponential distribution with rate parameter `lambda` at a probability `p`. */ double stdlib_base_dists_exponential_quantile( const double p, const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c index 194173dd782f..e00459c3aeb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c @@ -22,8 +22,8 @@ #include "stdlib/math/base/special/ln.h" /** -* Returns the quantile of an exponential distribution. -* +* Evaluates the quantile function for an exponential distribution with rate parameter `lambda` at a probability `p`. +* @param p - input probability * @param lambda rate parameter * @return quantile * From 8acabfbc81f7a5b553eb6152f204c053a451fa45 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Fri, 14 Feb 2025 22:52:10 -0500 Subject: [PATCH 4/4] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../dists/exponential/quantile/benchmark/benchmark.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js index d82487a20bad..d063732fd10f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/benchmark/benchmark.native.js @@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name;