feat(add c implementation): add stats/base/dists/bernoulli/kurtosis

Author: vivekmaurya001

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md

@@ -157,7 +157,7 @@ double out = stdlib_base_dists_bernoulli_kurtosis( 0.1 );
 
 The function accepts the following arguments:
 
--   **p**: `[in] double` maximum support.
+-   **p**: `[in] double` success probability.
 
 ```c
 double stdlib_base_dists_bernoulli_kurtosis( const double p );
@@ -192,8 +192,8 @@ int main( void ) {
     int i;
     
     for ( i = 0; i < 25; i++ ) {
-        p = ( (double)rand() / (double)RAND_MAX );
-        y = stdlib_base_dists_arcsine_entropy( p );
+        p = (double)rand() / ( (double)RAND_MAX + 1.0 );
+        y = stdlib_base_dists_bernoulli_kurtosis( p );
         printf( "p: %lf, Kurt(X;p): %lf\n", p, y );
     }
 }

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.js

@@ -21,6 +21,7 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
+var Float64Array = require( '@stdlib/array/float64' );
 var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
@@ -30,14 +31,20 @@ var kurtosis = require( './../lib' );
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
+	var len;
 	var p;
 	var y;
 	var i;
 
+	len = 100;
+	p = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		p[ i ] = randu();
+	}
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		p = randu();
-		y = kurtosis( p );
+		y = kurtosis( p[ i%len ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.native.js

@@ -0,0 +1,67 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var Float64Array = require( '@stdlib/array/float64' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var kurtosis = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( kurtosis instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var len;
+	var p;
+	var y;
+	var i;
+
+	len = 100;
+	p = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		p[ i ] = randu();
+	}
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = kurtosis( p[ i % len ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c

@@ -91,15 +91,18 @@ static double rand_double( void ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	double p;
+	double p[ 100 ];
 	double y;
 	double t;
 	int i;
 
+	for ( i = 0; i < 100; i++ ) {
+		p[ i ] = rand_double();
+	}
+
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		p = ( (double)rand() / (double)RAND_MAX ) ;
-		y = stdlib_base_dists_bernoulli_kurtosis( p );
+		y = stdlib_base_dists_bernoulli_kurtosis( p[ i%100 ] );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );
 			break;
@@ -130,4 +133,4 @@ int main( void ) {
 		printf( "ok %d benchmark finished\n", i+1 );
 	}
 	print_summary( REPEATS, REPEATS );
-}
+}

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c

@@ -26,8 +26,8 @@ int main( void ) {
 	int i;
 
 	for ( i = 0; i < 25; i++ ) {
-		p = ( (double)rand() / (double)RAND_MAX );
+		p = (double)rand() / ( (double)RAND_MAX + 1.0 );
 		y = stdlib_base_dists_bernoulli_kurtosis( p );
-		printf( "x: %lf , H(X;p): %lf\n", p, y );
+		printf( "x: %lf , Kurt(X;p): %lf\n", p, y );
 	}
 }

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js

@@ -28,20 +28,17 @@ var addon = require( './../src/addon.node' );
 /**
 * Returns the kurtosis of a Bernoulli distribution.
 *
+* @private
 * @param {Probability} p - success probability
 * @returns {PositiveNumber} kurtosis
 *
 * @example
 * var v = kurtosis( 0.1 );
-* // returns ~0.325
+* // returns ~5.111
 *
 * @example
 * var v = kurtosis( 0.5 );
-* // returns ~0.693
-*
-* @example
-* var v = kurtosis( 0.9 );
-* // returns ~0.325
+* // returns -2.0
 *
 * @example
 * var v = kurtosis( 1.1 );

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json

@@ -73,4 +73,4 @@
         ]
       }
     ]
-  }
+}

lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js

@@ -45,19 +45,19 @@ var opts = {
 
 // TESTS //
 
-tape( 'main export is a function', function test( t ) {
+tape( 'main export is a function', opts, function test( t ) {
 	t.ok( true, __filename );
 	t.strictEqual( typeof kurtosis, 'function', 'main export is a function' );
 	t.end();
 });
 
-tape( 'if provided `NaN` for `p`, the function returns `NaN`', function test( t ) {
+tape( 'if provided `NaN` for `p`, the function returns `NaN`', opts, function test( t ) {
 	var v = kurtosis( NaN );
 	t.equal( isnan( v ), true, 'returns NaN' );
 	t.end();
 });
 
-tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', function test( t ) {
+tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', opts, function test( t ) {
 	var v = kurtosis( 0.0 );
 	t.strictEqual( v, PINF, 'returns +infinity' );
 
@@ -67,7 +67,7 @@ tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', functi
 	t.end();
 });
 
-tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', function test( t ) {
+tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', opts, function test( t ) {
 	var v;
 
 	v = kurtosis( -1.0 );
@@ -85,7 +85,7 @@ tape( 'if provided a success probability `p` outside of `[0,1]`, the function re
 	t.end();
 });
 
-tape( 'the function returns the excess kurtosis of a Bernoulli distribution', function test( t ) {
+tape( 'the function returns the excess kurtosis of a Bernoulli distribution', opts, function test( t ) {
 	var expected;
 	var delta;
 	var tol;