Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -86,7 +86,6 @@ indent_style = tab
 [*.{f,f.txt}]
 indent_style = space
 indent_size = 2
-insert_final_newline = false
 
 # Set properties for shell files:
 [*.{sh,sh.txt}]

.github/.keepalive

@@ -2,6 +2,63 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2025-01-19)
+
+<section class="features">
+
+### Features
+
+-   [`ccaed30`](https://github.com/stdlib-js/stdlib/commit/ccaed309a4bfdc50b0c8f2c78f1ee4e365d51337) - add C implementation for `stats/base/dists/chisquare/variance` [(#3999)](https://github.com/stdlib-js/stdlib/pull/3999)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#3512](https://github.com/stdlib-js/stdlib/issues/3512)
+
+</section>
+
+<!-- /.issues -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`ccaed30`](https://github.com/stdlib-js/stdlib/commit/ccaed309a4bfdc50b0c8f2c78f1ee4e365d51337) - **feat:** add C implementation for `stats/base/dists/chisquare/variance` [(#3999)](https://github.com/stdlib-js/stdlib/pull/3999) _(by Vivek Maurya, Philipp Burckhardt, stdlib-bot)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 2 people contributed to this release. Thank you to the following contributors:
+
+-   Philipp Burckhardt
+-   Vivek Maurya
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.2">
 
 ## 0.2.2 (2024-07-27)

CHANGELOG.md

@@ -27,6 +27,8 @@ Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
 Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
+Dev Goel <135586571+corsairier@users.noreply.github.com>
+Dhruv Arvind Singh <154677013+DhruvArvindSingh@users.noreply.github.com>
 Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
 Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>
@@ -49,6 +51,7 @@ Joey Reed <joeyrreed@gmail.com>
 Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
+Karan Anand <119553199+anandkaranubc@users.noreply.github.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
 Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
@@ -117,7 +120,7 @@ UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
-Vivek maurya <155618190+vivekmaurya001@users.noreply.github.com>
+Vivek Maurya <vm8118134@gmail.com>
 Xiaochuan Ye <tap91624@gmail.com>
 Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>

CONTRIBUTORS

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2025 The Stdlib Authors.

NOTICE

@@ -149,6 +149,98 @@ 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/chisquare/variance.h"
+```
+
+#### stdlib_base_dists_chisquare_variance( k )
+
+Returns the [variance][variance] of a [chi-squared][chisquare-distribution] distribution with degrees of freedom `k`.
+
+```c
+double out = stdlib_base_dists_chisquare_variance( 9.0 );
+// returns 18.0
+```
+
+The function accepts the following arguments:
+
+-   **k**: `[in] double` degrees of freedom.
+
+```c
+double stdlib_base_dists_chisquare_variance( const double k );
+```
+
+</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/chisquare/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 k;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        k = random_uniform( 0.0, 20.0 );
+        y = stdlib_base_dists_chisquare_variance( k );
+        printf( "k: %lf, Var(X;k): %lf\n", k, 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">
@@ -191,7 +283,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

README.md

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

benchmark/benchmark.js

@@ -0,0 +1,68 @@
+/**
+* @license Apache-2.0
+*
+* 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.
+* 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-harness' );
+var Float64Array = require( '@stdlib/array-float64' );
+var randu = require( '@stdlib/random-base-randu' );
+var EPS = require( '@stdlib/constants-float64-eps' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var tryRequire = require( '@stdlib/utils-try-require' );
+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 len;
+	var k;
+	var y;
+	var i;
+
+	len = 100;
+	k = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		k[ i ] = ( randu() * 20.0 ) + EPS;
+	}
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = variance( k[ 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();
+});