Refactor random number generation in JS benchmarks

yuvi-mittal · yuvi-mittal · commit abc212ed65d6 · 2025-02-22T16:40:55.000+05:30
---
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
---

---
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
---

---
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
---

---
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
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/README.md
@@ -148,7 +148,7 @@ for ( i = 0; i < 10; i++ ) {
 
 #### stdlib_base_dists_planck_mean( lambda )
 
-Evaluates the mean for an planck distribution.
+Returns the expected value of a Planck distribution with shape parameter `lambda`.
 
 ```c
 double out = stdlib_base_dists_planck_mean( 0.1 );
@@ -187,20 +187,20 @@ double stdlib_base_dists_planck_mean( const double lambda );
 #include <stdio.h>
 
 static double random_uniform( const double min, const double max ) {
-	double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
-	return min + ( v * (max - min) );
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+    return min + ( v * (max - min) );
 }
 
 int main( void ) {
-	double lambda;
-	double y;
-	int i;
-
-	for ( i = 0; i < 25; i++ ) {
-		lambda = random_uniform( 0.1, 10.0 );
-		y = stdlib_base_dists_planck_mean( lambda );
-		printf( "lambda: %lf, E(X;λ): %lf\n", lambda, y );
-	}
+    double lambda;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        lambda = random_uniform( 0.1, 10.0 );
+        y = stdlib_base_dists_planck_mean( lambda );
+        printf( "λ: %lf, E(X;λ): %lf\n", lambda, y );
+    }
 }
 ```
 
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/benchmark.js
@@ -22,7 +22,7 @@
 
 var bench = require( '@stdlib/bench' );
 var Float64Array = require( '@stdlib/array/float64' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
 var mean = require( './../lib' );
@@ -31,16 +31,15 @@ var mean = require( './../lib' );
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var len;
 	var lambda;
+	var len;
 	var y;
 	var i;
 
-	len =100;
+	len = 100;
 	lambda = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		lambda[ i ] = ( randu() * 10.0 ) + 1.0;
-		
+		lambda[ i ] = uniform( 1.0, 10.0 );
 	}
 
 	b.tic();
@@ -57,4 +56,3 @@ bench( pkg, function benchmark( b ) {
 	b.pass( 'benchmark finished' );
 	b.end();
 });
-
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/benchmark.native.js
@@ -23,7 +23,7 @@
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
 var Float64Array = require( '@stdlib/array/float64' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
@@ -36,19 +36,19 @@ var opts = {
 	'skip': ( mean instanceof Error )
 };
 
+
 // MAIN //
 
 bench( pkg+'::native', opts, function benchmark( b ) {
-	var len;
 	var lambda;
+	var len;
 	var y;
 	var i;
 
-	len =100;
+	len = 100;
 	lambda = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		lambda[ i ] = ( randu() * 10.0 ) + 1.0;
-		
+		lambda[ i ] = uniform( 1.0, 10.0 );
 	}
 
 	b.tic();
@@ -65,4 +65,3 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	b.pass( 'benchmark finished' );
 	b.end();
 });
-
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/benchmark/c/benchmark.c
@@ -31,7 +31,7 @@
 * Prints the TAP version.
 */
 static void print_version( void ) {
-    printf( "TAP version 13\n" );
+	printf( "TAP version 13\n" );
 }
 
 /**
@@ -41,12 +41,12 @@ static void print_version( void ) {
 * @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" );
+	printf( "#\n" );
+	printf( "1..%d\n", total ); // TAP plan
+	printf( "# total %d\n", total );
+	printf( "# pass  %d\n", passing );
+	printf( "#\n" );
+	printf( "# ok\n" );
 }
 
 /**
@@ -55,12 +55,12 @@ static void print_summary( int total, int passing ) {
 * @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" );
+	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" );
 }
 
 /**
@@ -69,9 +69,9 @@ static void print_results( double elapsed ) {
 * @return clock time
 */
 static double tic( void ) {
-    struct timeval now;
-    gettimeofday( &now, NULL );
-    return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
+	struct timeval now;
+	gettimeofday( &now, NULL );
+	return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
 }
 
 /**
@@ -82,8 +82,8 @@ static double tic( void ) {
 * @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));
+	double v = (double)rand() / ((double)RAND_MAX + 1.0);
+	return min + (v * (max - min));
 }
 
 /**
@@ -92,49 +92,49 @@ static double random_uniform( const double min, const double max ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
-    double elapsed;
-    double lambda[100];
-    double y;
-    double t;
-    int i;
+	double elapsed;
+	double lambda[100];
+	double y;
+	double t;
+	int i;
 
-    for (i = 0; i < 100; i++) {
-        lambda[i] = random_uniform(0.1, 10.0);
-    }
+	for (i = 0; i < 100; i++) {
+		lambda[i] = random_uniform(0.1, 10.0);
+	}
 
-    t = tic();
-    for (i = 0; i < ITERATIONS; i++) {
-        y = stdlib_base_dists_planck_mean(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;
+	t = tic();
+	for (i = 0; i < ITERATIONS; i++) {
+		y = stdlib_base_dists_planck_mean(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;
+	double elapsed;
+	int i;
 
-    // Use the current time to seed the random number generator:
-    srand(time(NULL));
+	// 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);
+	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);
 
-    return 0;
+	return 0;
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/examples/c/example.c
@@ -16,8 +16,6 @@
 * limitations under the License.
 */
 
-// #include "stdlib/math/base/assert/is_nan.h"
-// #include "stdlib/math/base/special/expm1.h"
 #include "stdlib/stats/base/dists/planck/mean.h"
 #include <stdlib.h>
 #include <stdio.h>
@@ -35,6 +33,6 @@ int main( void ) {
 	for ( i = 0; i < 25; i++ ) {
 		lambda = random_uniform( 0.1, 10.0 );
 		y = stdlib_base_dists_planck_mean( lambda );
-		printf( "lambda: %lf, E(X;λ): %lf\n", lambda, y );
+		printf( "λ: %lf, E(X;λ): %lf\n", lambda, y );
 	}
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/include/stdlib/stats/base/dists/planck/mean.h b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/include/stdlib/stats/base/dists/planck/mean.h
@@ -27,10 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Evaluates the mean of the Planck distribution with given lambda .
-*
-* @param T - The temperature parameter of the Planck distribution (must be > 0)
-* @return The mean of the Planck distribution for the given temperature
+*Returns the expected value of a Planck distribution with shape parameter `lambda`.
 */
 double stdlib_base_dists_planck_mean( const double lambda );
 
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/lib/native.js
@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
 * Returns the expected value of a Planck distribution with shape parameter `lambda`.
 *
 * @private
-* @param {number} lambda - shape parameter (must be positive)
+* @param {PositiveNumber} lambda - shape parameter
 * @returns {NonNegativeNumber} expected value
 *
 * @example
@@ -53,7 +53,7 @@ var addon = require( './../src/addon.node' );
 * // returns NaN
 */
 function mean( lambda ) {
-    return addon( lambda );
+	return addon( lambda );
 }
 
 
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/manifest.json
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mean/src/main.c

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );`
`29`	`29`	* Returns the expected value of a Planck distribution with shape parameter `lambda`.
`30`	`30`	`*`
`31`	`31`	`* @private`
`32`		`-* @param {number} lambda - shape parameter (must be positive)`
	`32`	`+* @param {PositiveNumber} lambda - shape parameter`
`33`	`33`	`* @returns {NonNegativeNumber} expected value`
`34`	`34`	`*`
`35`	`35`	`* @example`
`@@ -53,7 +53,7 @@ var addon = require( './../src/addon.node' );`
`53`	`53`	`* // returns NaN`
`54`	`54`	`*/`
`55`	`55`	`function mean( lambda ) {`
`56`		`- return addon( lambda );`
	`56`	`+ return addon( lambda );`
`57`	`57`	`}`
`58`	`58`
`59`	`59`