feat: added new implementation and other minor updates

0PrashantYadav0 · 0PrashantYadav0 · commit ca035dd8c8d5 · 2025-01-06T18:02:37.000+05:30
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/README.md b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/README.md
@@ -167,20 +167,20 @@ for ( i = 0; i < 10; i++ ) {
 
 #### stdlib_base_dists_binomial_variance( n, p )
 
-Returns the variance of a binomial distribution.
+Returns the [variance][variance] of a [binomial][binomial-distribution] distribution with number of trials `n` and success probability `p`.
 
 ```c
-double out = stdlib_base_dists_binomial_variance( 10, 0.5 );
-// returns 2.5
+double out = stdlib_base_dists_binomial_variance( 100, 0.1 );
+// returns 0.9
 ```
 
 The function accepts the following arguments:
 
--   **n**: `[in] int` number of trials.
+-   **n**: `[in] int32_t` number of trials.
 -   **p**: `[in] double` success probability.
 
 ```c
-double stdlib_base_dists_binomial_variance( const int n, const double p );
+double stdlib_base_dists_binomial_variance( const int32_t n, const double p );
 ```
 
 </section>
@@ -203,26 +203,30 @@ double stdlib_base_dists_binomial_variance( const int n, const double p );
 
 ```c
 #include "stdlib/stats/base/dists/binomial/variance.h"
+#include "stdlib/math/base/special/ceil.h"
 #include <stdlib.h>
+#include <stdint.h>
 #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 ) );
+    return min + ( v * (max - min) );
 }
 
 int main( void ) {
-    int n;
+    int32_t n;
     double p;
     double y;
     int i;
 
     for ( i = 0; i < 25; i++ ) {
-        n = (int)random_uniform( 1, 100 );
-        p = random_uniform( 0, 1 );
+        n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) );
+        p = random_uniform( 0.0, 1.0 );
         y = stdlib_base_dists_binomial_variance( n, p );
-        printf( "n: %d, p: %lf, Var(X;n,p): %lf", n, p, y );
+        printf( "n: %d, p: %lf, Var(X;n,p): %lf\n", n, p, y );
     }
+
+    return 0;
 }
 ```
 
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/benchmark/benchmark.js
@@ -21,9 +21,10 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
+var ceil = require( '@stdlib/math/base/special/ceil' );
+var Int32Array = require( '@stdlib/array/int32' );
 var Float64Array = require( '@stdlib/array/float64' );
 var randu = require( '@stdlib/random/base/randu' );
-var floor = require( '@stdlib/math/base/special/floor' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
 var variance = require( './../lib' );
@@ -39,16 +40,16 @@ bench( pkg, function benchmark( b ) {
 	var i;
 
 	len = 100;
-	n = new Float64Array( len );
+	n = new Int32Array( len );
 	p = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		n[ i ] = floor( ( randu() * 100.0 ) ) + 1;
-		p[ i ] = ( randu() * 0.8 ) + 0.1;
+		n[ i ] = ceil( randu() * 100.0 );
+		p[ i ] = randu();
 	}
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = variance( n[ i % len ], p[ i % len ] );
+		y = variance( n[ i%len ], p[ i%len ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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.
@@ -22,9 +22,10 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
+var Int32Array = require( '@stdlib/array/int32' );
 var Float64Array = require( '@stdlib/array/float64' );
 var tryRequire = require( '@stdlib/utils/try-require' );
-var floor = require( '@stdlib/math/base/special/floor' );
+var ceil = require( '@stdlib/math/base/special/ceil' );
 var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
@@ -48,11 +49,11 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	var i;
 
 	len = 100;
-	n = new Float64Array( len );
+	n = new Int32Array( len );
 	p = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		n[ i ] = floor( ( randu() * 100.0 ) ) + 1;
-		p[ i ] = ( randu() * 0.8 ) + 0.1;
+		n[ i ] = ceil( randu() * 100.0 );
+		p[ i ] = randu();
 	}
 
 	b.tic();
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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/binomial/variance/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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.
@@ -17,7 +17,9 @@
 */
 
 #include "stdlib/stats/base/dists/binomial/variance.h"
+#include "stdlib/math/base/special/ceil.h"
 #include <stdlib.h>
+#include <stdint.h>
 #include <stdio.h>
 #include <math.h>
 #include <time.h>
@@ -93,15 +95,15 @@ static double random_uniform( const double min, const double max ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	double n[ 100 ];
+	int32_t n[ 100 ];
 	double p[ 100 ];
 	double y;
 	double t;
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		n[ i ] = random_uniform( 1, 100 );
-		p[ i ] = random_uniform( 0.1, 0.9 );
+		n[ i ] = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) );
+		p[ i ] = random_uniform( 0.0, 1.0 );
 	}
 
 	t = tic();
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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/binomial/variance/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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/binomial/variance/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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.
@@ -17,7 +17,9 @@
 */
 
 #include "stdlib/stats/base/dists/binomial/variance.h"
+#include "stdlib/math/base/special/ceil.h"
 #include <stdlib.h>
+#include <stdint.h>
 #include <stdio.h>
 
 static double random_uniform( const double min, const double max ) {
@@ -26,16 +28,16 @@ static double random_uniform( const double min, const double max ) {
 }
 
 int main( void ) {
-	double n;
+	int32_t n;
 	double p;
 	double y;
 	int i;
 
 	for ( i = 0; i < 25; i++ ) {
-		n = random_uniform( 1, 100 );
-		p = random_uniform( 0.1, 0.9 );
+		n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) );
+		p = random_uniform( 0.0, 1.0 );
 		y = stdlib_base_dists_binomial_variance( n, p );
-		printf( "n: %lf, p: %lf, Var(X;n,p): %lf\n", n, p, y );
+		printf( "n: %d, p: %lf, Var(X;n,p): %lf\n", n, p, y );
 	}
 
 	return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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/binomial/variance/include/stdlib/stats/base/dists/binomial/variance.h b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/include/stdlib/stats/base/dists/binomial/variance.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.
@@ -19,6 +19,8 @@
 #ifndef STDLIB_STATS_BASE_DISTS_BINOMIAL_VARIANCE_H
 #define STDLIB_STATS_BASE_DISTS_BINOMIAL_VARIANCE_H
 
+#include <stdint.h>
+
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
 */
@@ -27,9 +29,9 @@ extern "C" {
 #endif
 
 /**
-* Returns the variance of a binomial distribution.
+* Returns the variance of a binomial distribution with number of trials `n` and success probability `p`.
 */
-double stdlib_base_dists_binomial_variance( const double n, const double p );
+double stdlib_base_dists_binomial_variance( const int32_t n, const double p );
 
 #ifdef __cplusplus
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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.
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Returns the variance of a binomial distribution.
 *
+* @private
 * @param {NonNegativeInteger} n - number of trials
 * @param {Probability} p - success probability
 * @returns {PositiveNumber} variance
@@ -41,10 +42,6 @@ var addon = require( './../src/addon.node' );
 * // returns 5.0
 *
 * @example
-* var v = variance( 10.3, 0.5 );
-* // returns NaN
-*
-* @example
 * var v = variance( 20, 1.1 );
 * // returns NaN
 *
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/manifest.json
@@ -40,7 +40,8 @@
       "dependencies": [
         "@stdlib/math/base/napi/binary",
         "@stdlib/math/base/assert/is-nan",
-        "@stdlib/math/base/assert/is-nonnegative-integer"
+        "@stdlib/math/base/assert/is-nonnegative-integer",
+        "@stdlib/math/base/special/ceil"
       ]
     },
     {
@@ -56,7 +57,8 @@
       "libpath": [],
       "dependencies": [
         "@stdlib/math/base/assert/is-nan",
-        "@stdlib/math/base/assert/is-nonnegative-integer"
+        "@stdlib/math/base/assert/is-nonnegative-integer",
+        "@stdlib/math/base/special/ceil"
       ]
     },
     {
@@ -72,7 +74,8 @@
       "libpath": [],
       "dependencies": [
         "@stdlib/math/base/assert/is-nan",
-        "@stdlib/math/base/assert/is-nonnegative-integer"
+        "@stdlib/math/base/assert/is-nonnegative-integer",
+        "@stdlib/math/base/special/ceil"
       ]
     }
   ]
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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/binomial/variance/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/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.
@@ -20,4 +20,4 @@
 #include "stdlib/math/base/napi/binary.h"
 
 // cppcheck-suppress shadowFunction
-STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_binomial_variance );
+STDLIB_MATH_BASE_NAPI_MODULE_ID_D( stdlib_base_dists_binomial_variance );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/src/main.c
@@ -19,7 +19,7 @@
 #include "stdlib/stats/base/dists/binomial/variance.h"
 #include "stdlib/math/base/assert/is_nan.h"
 #include "stdlib/math/base/assert/is_nonnegative_integer.h"
-
+#include <stdint.h>
 /**
 * Returns the variance of a binomial distribution.
 *
@@ -28,17 +28,15 @@
 * @return   variance
 *
 * @example
-* double y = stdlib_base_dists_binomial_variance( 10, 0.5 );
-* // returns 2.5
+* double y = stdlib_base_dists_binomial_variance( 100, 0.1 );
+* // returns 0.9
 */
-double stdlib_base_dists_binomial_variance( const double n, const double p ) {
+double stdlib_base_dists_binomial_variance( const int32_t n, const double p ) {
 	if (
-		stdlib_base_is_nan( n ) ||
 		stdlib_base_is_nan( p ) ||
-		n < 0.0 ||
+		n < 0 ||
 		p < 0.0 ||
-		p > 1.0 ||
-		!stdlib_base_is_nonnegative_integer( n )
+		p > 1.0
 	) {
 		return 0.0 / 0.0;
 	}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/variance/test/test.native.js

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#/`
`2`	`2`	`# @license Apache-2.0`
`3`	`3`	`#`
`4`		`-# Copyright (c) 2024 The Stdlib Authors.`
	`4`	`+# Copyright (c) 2025 The Stdlib Authors.`
`5`	`5`	`#`
`6`	`6`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`7`	`7`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# @license Apache-2.0`
`2`	`2`	`#`
`3`		`-# Copyright (c) 2024 The Stdlib Authors.`
	`3`	`+# Copyright (c) 2025 The Stdlib Authors.`
`4`	`4`	`#`
`5`	`5`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`# you may not use this file except in compliance with the License.`