From 322c0a44335cb43288520c9b37bb4f2abd814cdc Mon Sep 17 00:00:00 2001 From: DhruvArvindSingh Date: Mon, 30 Dec 2024 13:43:51 +0000 Subject: [PATCH 1/3] feat: add c implementation for @stdlib/stats/base/dists/logistic/logpdf --- 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: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../base/dists/logistic/logpdf/README.md | 86 ++++++++ .../logistic/logpdf/benchmark/benchmark.js | 17 +- .../logpdf/benchmark/benchmark.native.js | 74 +++++++ .../logistic/logpdf/benchmark/c/Makefile | 146 +++++++++++++ .../logistic/logpdf/benchmark/c/benchmark.c | 143 +++++++++++++ .../base/dists/logistic/logpdf/binding.gyp | 170 +++++++++++++++ .../dists/logistic/logpdf/examples/c/Makefile | 146 +++++++++++++ .../logistic/logpdf/examples/c/example.c | 42 ++++ .../base/dists/logistic/logpdf/include.gypi | 53 +++++ .../stdlib/stats/base/dists/logistic/logpdf.h | 38 ++++ .../base/dists/logistic/logpdf/lib/native.js | 76 +++++++ .../base/dists/logistic/logpdf/manifest.json | 95 +++++++++ .../base/dists/logistic/logpdf/package.json | 3 + .../base/dists/logistic/logpdf/src/Makefile | 70 ++++++ .../base/dists/logistic/logpdf/src/addon.c | 23 ++ .../base/dists/logistic/logpdf/src/main.c | 89 ++++++++ .../dists/logistic/logpdf/test/test.native.js | 199 ++++++++++++++++++ 17 files changed, 1466 insertions(+), 4 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md index 4ca0f4f13c24..b4ffb4dbf3d1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md @@ -152,6 +152,92 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/logistic/logpdf.h" +``` + +#### stdlib_base_dists_logistic_logpdf( x, mu, s ) + +Returns the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. + +```c +double out = stdlib_base_dists_logistic_logpdf( 2.0, 0.0, 1.0 ); +// returns ~-2.254 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` value parameter. +- **mu**: `[in] double` location parameter. +- **s**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_logistic_logpdf( const double x, const double mu, const double s ); +``` + +
+ + +
+
+ + +
+### Examples +```c +#include "stdlib/stats/base/dists/logistic/logpdf.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 mu; + double s; + double x; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 10.0 ) - 5.0; + mu = random_uniform( 0.0, 10.0 ) - 5.0; + s = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_logistic_logpdf( x, mu, s ); + printf( "x: %lf, µ: %lf, s: %lf, Var(X;µ,s): %lf\n", x, mu, s, y ); + } +} +``` + +
+ + + +
+ + + + + +
+
+ + +
+ ### Examples + ```c #include "stdlib/stats/base/dists/logistic/logpdf.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 mu; double s; double x; double y; int i; + for ( i = 0; i < 25; i++ ) { - x = random_uniform( 0.0, 10.0 ) - 5.0; - mu = random_uniform( 0.0, 10.0 ) - 5.0; + x = random_uniform( -5.0, 5.0 ); + mu = random_uniform( -5.0, 5.0 ); s = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_logistic_logpdf( x, mu, s ); - printf( "x: %lf, µ: %lf, s: %lf, Var(X;µ,s): %lf\n", x, mu, s, y ); + printf( "x: %lf, µ: %lf, s: %lf, ln(f(x;µ,s)): %lf\n", x, mu, s, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/benchmark.native.js index 1bc873c62006..a3d5cda5b218 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/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; @@ -53,9 +53,9 @@ bench( pkg, opts, function benchmark( b ) { s = new Float64Array( len ); x = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - x[ i ] = ( randu()*100.0 ) - 100; - mu[ i ] = ( randu()*100.0 ) - 50.0; - s[ i ] = ( randu()*20.0 ) + EPS; + x[ i ] = uniform( -100.0, 0.0 ); + mu[ i ] = uniform( -50.0, 50.0 ); + s[ i ] = uniform( EPS, 20.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/benchmark.c index 7b84855d4f86..6f8901db2b82 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/benchmark/c/benchmark.c @@ -102,9 +102,9 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - x[ i ] = random_uniform( 0.0, 100.0 ) - 100.0; - mu[ i ] = random_uniform( 0.0, 100.0 ) + 50.0; - s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + x[ i ] = random_uniform( -100.0, 0.0 ); + mu[ i ] = random_uniform( 50.0, 100.0 ); + s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/example.c index ac5f5f5da60c..b26073a8d7e1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/examples/c/example.c @@ -33,10 +33,10 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - mu = random_uniform( 0.0, 10.0 ); - s = random_uniform( 0.0, 10.0 ); + mu = random_uniform( -5.0, 5.0 ); + s = random_uniform( -5.0, 5.0 ); x = random_uniform( 0.0, 10.0 ); y = stdlib_base_dists_logistic_logpdf( x, mu, s ); - printf( "x: %lf, µ: %lf, s: %lf, Logpdf(X;x,µ,s): %lf\n", x, mu, s, y ); + printf( "x: %lf, µ: %lf, s: %lf, ln(f(x;µ,s)): %lf\n", x, mu, s, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h index a831287bff87..8de6cb521f2f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. */ double stdlib_base_dists_logistic_logpdf( const double x, const double mu, const double s ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js index f7f2c241b7da..255fe09e0e65 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * +* @private * @param {number} x - input value * @param {number} mu - location parameter * @param {NonNegativeNumber} s - scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c index 905a5f265164..7dff37078493 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c @@ -28,43 +28,14 @@ /** * Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * -* @param {number} x - input value -* @param {number} mu - location parameter -* @param {NonNegativeNumber} s - scale parameter -* @returns {number} evaluated logPDF +* @param x input value +* @param mu location parameter +* @param s scale parameter +* @returns evaluated logPDF * * @example * double y = stdlib_base_dists_logistic_logpdf( 2.0, 0.0, 1.0 ); * // returns ~-2.254 -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( -1.0, 4.0, 2.0 ); -* // returns ~-3.351 -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( NaN, 0.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( 0.0, NaN, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( 0.0, 0.0, NaN ); -* // returns NaN -* -* @example -* // Negative scale parameter: -* double y = stdlib_base_dists_logistic_logpdf( 2.0, 0.0, -1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( 2.0, 8.0, 0.0 ); -* // returns -Infinity -* -* @example -* double y = stdlib_base_dists_logistic_logpdf( 8.0, 8.0, 0.0 ); -* // returns Infinity */ double stdlib_base_dists_logistic_logpdf( const double x, const double mu, const double s ) { double az;