Merge branch 'stdlib-js:develop' into chisquare/stdev

Author: vivekmaurya001

lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js

@@ -23,14 +23,10 @@
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var isIntegerf = require( '@stdlib/math/base/assert/is-integerf' );
 var absf = require( '@stdlib/math/base/special/absf' );
+var MAX_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
 var NEGALUCAS = require( './negalucas.json' );
 
 
-// VARIABLES //
-
-var MAX_LUCAS = 34;
-
-
 // MAIN //
 
 /**

lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json

@@ -37,7 +37,8 @@
       "libpath": [],
       "dependencies": [
         "@stdlib/math/base/napi/unary",
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     },
     {
@@ -51,7 +52,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     },
     {
@@ -65,7 +67,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     }
   ]

lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c

@@ -18,7 +18,7 @@
 
 #include "stdlib/math/base/special/negalucasf.h"
 #include "stdlib/math/base/special/labs.h"
-#define STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS 34
+#include "stdlib/constants/float32/max_safe_nth_lucas.h"
 
 static const int32_t negalucasf_value[ 35 ] = {
 	2,

lib/node_modules/@stdlib/stats/base/dists/lognormal/variance/README.md

@@ -134,6 +134,101 @@ for ( i = 0; i < 10; i++ ) {
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/lognormal/variance.h"
+```
+
+#### stdlib_base_dists_lognormal_variance( mu, sigma )
+
+Returns the variance for a lognormal distribution with location `mu` and scale `sigma`.
+
+```c
+double out = stdlib_base_dists_lognormal_variance( 0.0, 1.0 );
+// returns ~4.671
+```
+
+The function accepts the following arguments:
+
+-   **mu**: `[in] double` location parameter.
+-   **sigma**: `[in] double` scale parameter.
+
+```c
+double stdlib_base_dists_lognormal_variance( const double mu, const double sigma );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/lognormal/variance.h"
+#include <stdlib.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) );
+}
+
+int main( void ) {
+    double sigma;
+    double mu;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        mu = random_uniform( 0.0, 10.0 ) - 5.0;
+        sigma = random_uniform( 0.0, 20.0 );
+        y = stdlib_base_dists_lognormal_variance( mu, sigma );
+        printf( "µ: %lf, σ: %lf, Var(X;µ,σ): %lf\n", mu, sigma, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 <section class="references">

lib/node_modules/@stdlib/stats/base/dists/lognormal/variance/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 EPS = require( '@stdlib/constants/float64/eps' );
@@ -32,15 +33,22 @@ var variance = require( './../lib' );
 
 bench( pkg, function benchmark( b ) {
 	var sigma;
+	var len;
 	var mu;
 	var y;
 	var i;
 
+	len = 100;
+	mu = new Float64Array( len );
+	sigma = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		mu[ i ] = ( randu() * 100.0 ) - 50.0;
+		sigma[ i ] = ( randu() * 20.0 ) + EPS;
+	}
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		mu = ( randu()*100.0 ) - 50.0;
-		sigma = ( randu()*20.0 ) + EPS;
-		y = variance( mu, sigma );
+		y = variance( mu[ i % len ], sigma[ i % len ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/stats/base/dists/lognormal/variance/benchmark/benchmark.native.js

@@ -0,0 +1,71 @@
+/**
+* @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 tryRequire = require( '@stdlib/utils/try-require' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var EPS = require( '@stdlib/constants/float64/eps' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var variance = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( variance instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var sigma;
+	var len;
+	var mu;
+	var y;
+	var i;
+
+	len = 100;
+	mu = new Float64Array( len );
+	sigma = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		mu[ i ] = ( randu() * 100.0 ) - 50.0;
+		sigma[ i ] = ( randu() * 20.0 ) + EPS;
+	}
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = variance( mu[ i % len ], sigma[ 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();
+});