From 017fb67bcd5002d5e70a8c3408d75cfd83b5c5e8 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Fri, 20 Dec 2024 19:21:33 +0530 Subject: [PATCH 01/10] feat: add C implementation for geometric quantile --- .../base/dists/geometric/quantile/README.md | 99 ++++++++++ .../geometric/quantile/benchmark/benchmark.js | 14 +- .../quantile/benchmark/benchmark.native.js | 71 ++++++++ .../geometric/quantile/benchmark/c/Makefile | 146 +++++++++++++++ .../quantile/benchmark/c/benchmark.c | 139 ++++++++++++++ .../base/dists/geometric/quantile/binding.gyp | 170 ++++++++++++++++++ .../geometric/quantile/examples/c/Makefile | 146 +++++++++++++++ .../geometric/quantile/examples/c/example.c | 40 +++++ .../dists/geometric/quantile/include.gypi | 53 ++++++ .../stats/base/dists/geometric/quantile.h | 38 ++++ .../dists/geometric/quantile/lib/native.js | 74 ++++++++ .../dists/geometric/quantile/manifest.json | 83 +++++++++ .../dists/geometric/quantile/package.json | 3 + .../dists/geometric/quantile/src/Makefile | 70 ++++++++ .../base/dists/geometric/quantile/src/addon.c | 23 +++ .../base/dists/geometric/quantile/src/main.c | 51 ++++++ .../geometric/quantile/test/test.native.js | 142 +++++++++++++++ 17 files changed, 1359 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/include/stdlib/stats/base/dists/geometric/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/README.md index 0c279173fb44..fc00cd791f0a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/README.md @@ -145,6 +145,105 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/geometric/quantile.h" +``` + +#### stdlib_base_dists_geometric_quantile( p, p_success ) + +Evaluates the quantile function of a geometric distribution. + +```c +double out = stdlib_base_dists_geometric_quantile( 0.5, 0.4 ); +// returns 1 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **p_success**: `[in] double` success probability. + +```c +double stdlib_base_dists_geometric_quantile( const double r, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/geometric/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 p; + double r; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + r = random_uniform( 0.0, 1.0 ); + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_geometric_quantile( r, p ); + printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); + } +} +``` + +
+ + + + + +
+ +
+ + + + + +
From 4a951ab28e487bb837762eb07cc9de739d1958a7 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 6 Mar 2025 22:26:55 -0500 Subject: [PATCH 09/10] fix: allow r = 0 as input Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/geometric/quantile/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/main.c index 16719bb5fd75..ef8a5228bd16 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/src/main.c @@ -40,7 +40,7 @@ double stdlib_base_dists_geometric_quantile( const double r, const double p ) { stdlib_base_is_nan( p ) || p < 0.0 || p > 1.0 || - r <= 0.0 || + r < 0.0 || r > 1.0 ) { return 0.0 / 0.0; // NaN From 6f28f0dd486b4a1b1844fec9173c8d292d5f4e41 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 6 Mar 2025 22:27:45 -0500 Subject: [PATCH 10/10] docs: add private annotation Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/geometric/quantile/lib/native.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/lib/native.js index 42aea01ec276..6d84712e699f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/quantile/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Evaluates the quantile function for a geometric distribution with success probability `p` at a probability `r`. * +* @private * @param {Probability} r - input value * @param {Probability} p - success probability * @returns {NonNegativeInteger} evaluated quantile function