Auto-generated commit

stdlib-bot · stdlib-bot · commit 56c0c0023608 · 2024-12-18T23:52:18.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1561,6 +1561,7 @@ A total of 14 people contributed to this release. Thank you to the following con
 
 <details>
 
+-   [`8bf8285`](https://github.com/stdlib-js/stdlib/commit/8bf8285aba0ecbd00ae145c4c5c098cd28135814) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`9685979`](https://github.com/stdlib-js/stdlib/commit/968597945b0e8d1042ce17b6e08ca0f3e64058b4) - **feat:** add C implementation for `stats/base/dists/logistic/variance` [(#3994)](https://github.com/stdlib-js/stdlib/pull/3994) _(by Aayush Khanna, stdlib-bot)_
 -   [`c0d9c76`](https://github.com/stdlib-js/stdlib/commit/c0d9c760c9657e28d6b1d3daf5013708a928ae6c) - **feat:** add C implementation `stats/base/dists/rayleigh/pdf` [(#3945)](https://github.com/stdlib-js/stdlib/pull/3945) _(by Vinit Pandit, Philipp Burckhardt)_
 -   [`3a05645`](https://github.com/stdlib-js/stdlib/commit/3a05645a2054675503b44dffb2f6817298bc9bd9) - **feat:** add C implementation of `stats/base/dists/rayleigh/logcdf` [(#3957)](https://github.com/stdlib-js/stdlib/pull/3957) _(by Vinit Pandit, Philipp Burckhardt)_
diff --git a/base/dists/arcsine/entropy/benchmark/c/benchmark.c b/base/dists/arcsine/entropy/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		a[ i ] = random_uniform( 0, 20 );
-		b[ i ] = random_uniform( 0, 20 ) + a[ i ];
+		a[ i ] = random_uniform( 0.0, 20.0 );
+		b[ i ] = random_uniform( 0.0, 20.0 ) + a[ i ];
 	}
 
 	t = tic();
diff --git a/base/dists/arcsine/variance/benchmark/benchmark.native.js b/base/dists/arcsine/variance/benchmark/benchmark.native.js
@@ -30,7 +30,7 @@ var variance = require( './../lib' );
 
 // MAIN //
 
-bench( pkg, function benchmark( b ) {
+bench( pkg+'::native', function benchmark( b ) {
 	var min;
 	var max;
 	var len;
diff --git a/base/dists/bernoulli/mean/examples/c/example.c b/base/dists/bernoulli/mean/examples/c/example.c
@@ -28,6 +28,6 @@ int main( void ) {
 	for ( i = 0; i < 25; i++ ) {
 		p = (double)rand() / ( (double)RAND_MAX + 1.0 );
 		y = stdlib_base_dists_bernoulli_mean( p );
-		printf( "x: %lf , E(X;p): %lf\n", p , y );
+		printf( "x: %lf, E(X;p): %lf\n", p, y );
 	}
 }
diff --git a/base/dists/bernoulli/mode/examples/c/example.c b/base/dists/bernoulli/mode/examples/c/example.c
@@ -28,6 +28,6 @@ int main( void ) {
 	for ( i = 0; i < 25; i++ ) {
 		p = (double)rand() / ( (double)RAND_MAX + 1.0 );
 		y = stdlib_base_dists_bernoulli_mode( p );
-		printf( "x: %lf , H(X;p): %lf\n", p , y );
+		printf( "x: %lf, H(X;p): %lf\n", p, y );
 	}
 }
diff --git a/base/dists/beta/mode/src/main.c b/base/dists/beta/mode/src/main.c
@@ -18,7 +18,6 @@
 
 #include "stdlib/stats/base/dists/beta/mode.h"
 
-
 /**
 * Returns the mode of a beta distribution.
 *
diff --git a/base/dists/beta/variance/src/main.c b/base/dists/beta/variance/src/main.c
@@ -18,7 +18,6 @@
 
 #include "stdlib/stats/base/dists/beta/variance.h"
 
-
 /**
 * Returns the variance of a beta distribution.
 *
diff --git a/base/dists/betaprime/kurtosis/benchmark/c/benchmark.c b/base/dists/betaprime/kurtosis/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0, 20 );
-		beta[ i ] = random_uniform( 0, 20 ) + 4.0;
+		alpha[ i ] = random_uniform( 0.0, 20.0 );
+		beta[ i ] = random_uniform( 0.0, 20.0 ) + 4.0;
 	}
 
 	t = tic();
diff --git a/base/dists/betaprime/skewness/benchmark/c/benchmark.c b/base/dists/betaprime/skewness/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0, 20 );
-		beta[ i ] = random_uniform( 0, 20 ) + 3.0;
+		alpha[ i ] = random_uniform( 0.0, 20.0 );
+		beta[ i ] = random_uniform( 0.0, 20.0 ) + 3.0;
 	}
 
 	t = tic();
diff --git a/base/dists/betaprime/stdev/benchmark/c/benchmark.c b/base/dists/betaprime/stdev/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0, 20 );
-		beta[ i ] = random_uniform( 0, 20 ) + 2.0;
+		alpha[ i ] = random_uniform( 0.0, 20.0 );
+		beta[ i ] = random_uniform( 0.0, 20.0 ) + 2.0;
 	}
 
 	t = tic();
diff --git a/base/dists/betaprime/variance/benchmark/c/benchmark.c b/base/dists/betaprime/variance/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0, 20 );
-		beta[ i ] = random_uniform( 0, 20 ) + 2.0;
+		alpha[ i ] = random_uniform( 0.0, 20.0 );
+		beta[ i ] = random_uniform( 0.0, 20.0 ) + 2.0;
 	}
 
 	t = tic();
diff --git a/base/dists/cauchy/entropy/lib/native.js b/base/dists/cauchy/entropy/lib/native.js
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Returns the differential entropy of a Cauchy distribution.
 *
+* @private
 * @param {number} x0 - location parameter
 * @param {PositiveNumber} gamma - scale parameter
 * @returns {PositiveNumber} entropy
diff --git a/base/dists/cauchy/entropy/src/main.c b/base/dists/cauchy/entropy/src/main.c
@@ -20,6 +20,7 @@
 #include "stdlib/math/base/assert/is_nan.h"
 #include "stdlib/math/base/special/ln.h"
 #include "stdlib/constants/float64/pi.h"
+
 /**
 * Returns the differential entropy of a Cauchy distribution.
 *
diff --git a/base/dists/chi/mode/src/main.c b/base/dists/chi/mode/src/main.c
@@ -19,6 +19,7 @@
 #include "stdlib/stats/base/dists/chi/mode.h"
 #include "stdlib/math/base/assert/is_nan.h"
 #include "stdlib/math/base/special/sqrt.h"
+
 /**
 * Returns the mode of a chi distribution.
 *
@@ -31,7 +32,7 @@
 */
 double stdlib_base_dists_chi_mode( const double k ) {
 	if ( stdlib_base_is_nan( k ) || k < 1.0 ) {
-		return 0.0/0.0; //NaN
+		return 0.0/0.0; // NaN
 	}
 	return stdlib_base_sqrt( k - 1.0 );
 }
diff --git a/base/dists/invgamma/entropy/benchmark/c/benchmark.c b/base/dists/invgamma/entropy/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0, 20 );
-		beta[ i ] = random_uniform( 0, 20 );
+		alpha[ i ] = random_uniform( 0.0, 20.0 );
+		beta[ i ] = random_uniform( 0.0, 20.0 );
 	}
 
 	t = tic();
diff --git a/base/dists/pareto-type1/stdev/benchmark/c/benchmark.c b/base/dists/pareto-type1/stdev/benchmark/c/benchmark.c
@@ -100,8 +100,8 @@ static double benchmark( void ) {
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		alpha[ i ] = random_uniform( 0.0, 10.0 );
-		beta[ i ] = random_uniform( 0.0, 10.0 ) + 2.0;
+		alpha[ i ] = random_uniform( 0.0, 10.0 ) + 1.0;
+		beta[ i ] = random_uniform( 0.0, 10.0 ) + 1.0;
 	}
 
 	t = tic();
diff --git a/base/dists/poisson/mean/examples/c/example.c b/base/dists/poisson/mean/examples/c/example.c
@@ -28,6 +28,6 @@ int main( void ) {
 	for ( i = 0; i < 10; i++ ) {
 		lambda = 20.0 * (double)rand() / ( (double)RAND_MAX + 1.0 );
 		v = stdlib_base_dists_poisson_mean( lambda );
-		printf( "λ: %lf , E(X;λ): %lf\n", lambda , v );
+		printf( "λ: %lf, E(X;λ): %lf\n", lambda, v );
 	}
 }
diff --git a/base/dists/poisson/mean/include/stdlib/stats/base/dists/poisson/mean.h b/base/dists/poisson/mean/include/stdlib/stats/base/dists/poisson/mean.h
@@ -25,6 +25,7 @@
 #ifdef __cplusplus
 extern "C" {
 #endif
+
 /**
 * Returns the mean of a Poisson distribution with mean parameter `lambda`.
 */
diff --git a/base/dists/poisson/mean/lib/native.js b/base/dists/poisson/mean/lib/native.js
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Returns the expected value of a Poisson distribution.
 *
+* @private
 * @param {NonNegativeNumber} lambda - mean parameter
 * @returns {NonNegativeNumber} expected value
 *
diff --git a/base/dists/poisson/mean/src/main.c b/base/dists/poisson/mean/src/main.c
@@ -22,24 +22,12 @@
 /**
 * Returns the expected value of a Poisson distribution.
 *
-* @param {NonNegativeNumber} lambda - mean parameter
-* @returns {NonNegativeNumber} expected value
+* @param lambda    mean parameter
+* @return          expected value
 *
 * @example
-* var v = mean( 9.0 );
+* double v = mean( 9.0 );
 * // returns 9.0
-*
-* @example
-* var v = mean( 1.0 );
-* // returns 1.0
-*
-* @example
-* var v = mean( -0.2 );
-* // returns NaN
-*
-* @example
-* var v = mean( NaN );
-* // returns NaN
 */
 double stdlib_base_dists_poisson_mean( const double lambda ) {
 	if (
diff --git a/base/dists/rayleigh/cdf/benchmark/c/benchmark.c b/base/dists/rayleigh/cdf/benchmark/c/benchmark.c
@@ -102,7 +102,7 @@ static double benchmark( void ) {
 
 	for ( i = 0; i < 100; i++ ) {
 		x[ i ] = random_uniform( -100.0, 0.0 );
-		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS , STDLIB_CONSTANT_FLOAT64_EPS + 20 );
+		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
 	}
 
 	t = tic();
diff --git a/base/dists/rayleigh/cdf/src/main.c b/base/dists/rayleigh/cdf/src/main.c
@@ -21,7 +21,6 @@
 #include "stdlib/math/base/special/exp.h"
 #include "stdlib/math/base/special/pow.h"
 
-
 /**
 * Evaluates the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
 *
diff --git a/base/dists/rayleigh/entropy/benchmark/c/benchmark.c b/base/dists/rayleigh/entropy/benchmark/c/benchmark.c
@@ -101,7 +101,7 @@ static double benchmark( void ) {
 
 
 	for ( i = 0; i < 100; i++ ) {
-		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS , STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
+		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
 	}
 
 	t = tic();
diff --git a/base/dists/rayleigh/entropy/src/main.c b/base/dists/rayleigh/entropy/src/main.c
@@ -22,7 +22,6 @@
 #include "stdlib/constants/float64/eulergamma.h"
 #include "stdlib/constants/float64/sqrt_two.h"
 
-
 /**
 * Returns the differential entropy of a Rayleigh distribution.
 *
diff --git a/base/dists/rayleigh/logcdf/benchmark/c/benchmark.c b/base/dists/rayleigh/logcdf/benchmark/c/benchmark.c
@@ -18,7 +18,6 @@
 
 #include "stdlib/stats/base/dists/rayleigh/logcdf.h"
 #include "stdlib/constants/float64/eps.h"
-#include "stdlib/math/base/assert/is_nan.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
@@ -103,7 +102,7 @@ static double benchmark( void ) {
 
 	for ( i = 0; i < 100; i++ ) {
 		x[ i ] = random_uniform( -100.0, 0.0 );
-		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS , STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
+		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
 	}
 
 	t = tic();
diff --git a/base/dists/rayleigh/logcdf/src/main.c b/base/dists/rayleigh/logcdf/src/main.c
@@ -25,6 +25,7 @@
 #include "stdlib/math/base/special/ln.h"
 #include "stdlib/constants/float64/ln_half.h"
 #include "stdlib/constants/float64/ninf.h"
+
 /**
 * Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
 *
diff --git a/base/dists/rayleigh/pdf/benchmark/c/benchmark.c b/base/dists/rayleigh/pdf/benchmark/c/benchmark.c
@@ -102,7 +102,7 @@ static double benchmark( void ) {
 
 	for ( i = 0; i < 100; i++ ) {
 		x[ i ] = random_uniform( -100.0, 0.0 );
-		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS , STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
+		sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
 	}
 
 	t = tic();
diff --git a/base/dists/rayleigh/pdf/src/main.c b/base/dists/rayleigh/pdf/src/main.c
@@ -21,6 +21,7 @@
 #include "stdlib/math/base/special/exp.h"
 #include "stdlib/math/base/special/pow.h"
 #include "stdlib/constants/float64/pinf.h"
+
 /**
 * Evaluates the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
 *
diff --git a/base/dists/uniform/pdf/lib/native.js b/base/dists/uniform/pdf/lib/native.js
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Evaluates the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`.
 *
+* @private
 * @param {number} x - input value
 * @param {number} a - minimum support
 * @param {number} b - maximum support
diff --git a/base/dists/uniform/pdf/src/main.c b/base/dists/uniform/pdf/src/main.c
@@ -22,34 +22,14 @@
 /**
 * Evaluates the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`.
 *
-* @param {number} x - input value
-* @param {number} a - minimum support
-* @param {number} b - maximum support
-* @returns {number} evaluated PDF
+* @param x    input value
+* @param a    minimum support
+* @param b    maximum support
+* @return     evaluated PDF
 *
 * @example
-* var y = pdf( 2.0, 0.0, 4.0 );
+* double y = pdf( 2.0, 0.0, 4.0 );
 * // returns 0.25
-*
-* @example
-* var y = pdf( 5.0, 0.0, 4.0 );
-* // returns 0.0
-*
-* @example
-* var y = pdf( 0.25, 0.0, 1.0 );
-* // returns 1.0
-*
-* @example
-* var y = pdf( NaN, 0.0, 1.0 );
-* // returns NaN
-*
-* @example
-* var y = pdf( 0.0, NaN, 1.0 );
-* // returns NaN
-*
-* @example
-* var y = pdf( 2.0, 3.0, 1.0 );
-* // returns NaN
 */
 double stdlib_base_dists_uniform_pdf( const double x, const double a, const double b ) {
 	if (

Original file line number	Diff line number	Diff line change
`@@ -100,8 +100,8 @@ static double benchmark( void ) {`
`100`	`100`	`int i;`
`101`	`101`
`102`	`102`	`for ( i = 0; i < 100; i++ ) {`
`103`		`- a[ i ] = random_uniform( 0, 20 );`
`104`		`- b[ i ] = random_uniform( 0, 20 ) + a[ i ];`
	`103`	`+ a[ i ] = random_uniform( 0.0, 20.0 );`
	`104`	`+ b[ i ] = random_uniform( 0.0, 20.0 ) + a[ i ];`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`t = tic();`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ int main( void ) {`
`28`	`28`	`for ( i = 0; i < 25; i++ ) {`
`29`	`29`	`p = (double)rand() / ( (double)RAND_MAX + 1.0 );`
`30`	`30`	`y = stdlib_base_dists_bernoulli_mean( p );`
`31`		`- printf( "x: %lf , E(X;p): %lf\n", p , y );`
	`31`	`+ printf( "x: %lf, E(X;p): %lf\n", p, y );`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@`
`18`	`18`
`19`	`19`	`#include "stdlib/stats/base/dists/beta/mode.h"`
`20`	`20`
`21`		`-`
`22`	`21`	`/**`
`23`	`22`	`* Returns the mode of a beta distribution.`
`24`	`23`	`*`