Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,36 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-11-11)
+## Unreleased (2024-11-17)
 
 <section class="packages">
 
 ### Packages
 
+<section class="package" id="stats-base-dists-chisquare-unreleased">
+
+#### [@stdlib/stats/base/dists/chisquare](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/chisquare)
+
+<details>
+
+<section class="issues">
+
+##### Closed Issues
+
+This release closes the following issue:
+
+[#1619](https://github.com/stdlib-js/stdlib/issues/1619)
+
+</section>
+
+<!-- /.issues -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="stats-base-dists-kumaraswamy-unreleased">
 
 #### [@stdlib/stats/base/dists/kumaraswamy](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/kumaraswamy)
@@ -66,9 +90,9 @@ This release closes the following issue:
 
 ### Closed Issues
 
-A total of 2 issues were closed in this release:
+A total of 3 issues were closed in this release:
 
-[#1632](https://github.com/stdlib-js/stdlib/issues/1632), [#1633](https://github.com/stdlib-js/stdlib/issues/1633)
+[#1619](https://github.com/stdlib-js/stdlib/issues/1619), [#1632](https://github.com/stdlib-js/stdlib/issues/1632), [#1633](https://github.com/stdlib-js/stdlib/issues/1633)
 
 </section>
 
@@ -78,10 +102,11 @@ A total of 2 issues were closed in this release:
 
 ### Contributors
 
-A total of 3 people contributed to this release. Thank you to the following contributors:
+A total of 4 people contributed to this release. Thank you to the following contributors:
 
+-   Kohantika Nath
 -   Philipp Burckhardt
--   Pratyush
+-   Pratyush Kumar Chouhan
 -   Ruthwik Chikoti
 
 </section>
@@ -94,8 +119,9 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`28bdda3`](https://github.com/stdlib-js/stdlib/commit/28bdda3affa89470bbdf531cb3bbc233c85d3d17) - **docs:** improve examples of `stats/base/dists/chisquare` namespace [(#2678)](https://github.com/stdlib-js/stdlib/pull/2678) _(by Kohantika Nath, Philipp Burckhardt)_
 -   [`4e1c68b`](https://github.com/stdlib-js/stdlib/commit/4e1c68b10906fea989b1a785405eb17d68553461) - **docs:** improve examples of `stats/base/dists/kumaraswamy` [(#2605)](https://github.com/stdlib-js/stdlib/pull/2605) _(by Ruthwik Chikoti, Philipp Burckhardt)_
--   [`19c8688`](https://github.com/stdlib-js/stdlib/commit/19c868816d201337c4cb77683c2ff0a306b81e95) - **docs:** improve README examples of `stats/base/dists/laplace` namespace [(#1875)](https://github.com/stdlib-js/stdlib/pull/1875) _(by Pratyush, Philipp Burckhardt)_
+-   [`19c8688`](https://github.com/stdlib-js/stdlib/commit/19c868816d201337c4cb77683c2ff0a306b81e95) - **docs:** improve README examples of `stats/base/dists/laplace` namespace [(#1875)](https://github.com/stdlib-js/stdlib/pull/1875) _(by Pratyush Kumar Chouhan, Philipp Burckhardt)_
 
 </details>
 

CONTRIBUTORS

@@ -59,6 +59,7 @@ Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
+Neeraj Pathak <[email protected]>
 NightKnight <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
@@ -69,6 +70,7 @@ Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
 Praneki <[email protected]>
 Pratik <[email protected]>
+Pratyush Kumar Chouhan <[email protected]>
 Priyansh <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 RISHAV <[email protected]>
@@ -79,6 +81,7 @@ Ridam Garg <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
 Rutam <[email protected]>
+Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 SarthakPaandey <[email protected]>

base/dists/chisquare/README.md

@@ -108,10 +108,36 @@ var mu = dist.mean;
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var objectKeys = require( '@stdlib/utils/keys' );
+var roundn = require( '@stdlib/math/base/special/roundn' );
 var chisquare = require( '@stdlib/stats/base/dists/chisquare' );
 
-console.log( objectKeys( chisquare ) );
+// Define degrees of freedom:
+var k = 5.0;
+
+// Calculate distribution properties:
+console.log( 'Mean: %d', chisquare.mean( k ) );
+console.log( 'Median: %d', roundn( chisquare.median( k ), -4 ) );
+console.log( 'Mode: %d', chisquare.mode( k ) );
+console.log( 'Variance: %d', chisquare.variance( k ) );
+console.log( 'Standard Deviation: %d', roundn( chisquare.stdev( k ), -4 ) );
+console.log( 'Skewness: %d', roundn( chisquare.skewness( k ), -4 ) );
+console.log( 'Excess Kurtosis: %d', roundn( chisquare.kurtosis( k ), -4 ) );
+console.log( 'Entropy: %d', roundn( chisquare.entropy( k ), -4 ) );
+
+// Evaluate probability functions:
+var x = 3.0;
+console.log( '\nEvaluating at x = %d', x );
+console.log( 'PDF: %d', roundn( chisquare.pdf( x, k ), -4 ) );
+console.log( 'logPDF: %d', roundn( chisquare.logpdf( x, k ), -4 ) );
+console.log( 'CDF: %d', roundn( chisquare.cdf( x, k ), -4 ) );
+
+// Calculate quantiles:
+var p = 0.7;
+console.log( '\nQuantile at p = %d: %d', p, roundn( chisquare.quantile( p, k ), -4 ) );
+
+// Evaluate moment-generating function:
+var t = 0.1;
+console.log( 'MGF at t = %d: %d', t, roundn( chisquare.mgf( t, k ), -4 ) );
 ```
 
 </section>

base/dists/chisquare/examples/index.js

@@ -18,7 +18,33 @@
 
 'use strict';
 
-var objectKeys = require( '@stdlib/utils/keys' );
+var roundn = require( '@stdlib/math/base/special/roundn' );
 var chisquare = require( './../lib' );
 
-console.log( objectKeys( chisquare ) );
+// Define degrees of freedom:
+var k = 5.0;
+
+// Calculate distribution properties:
+console.log( 'Mean: %d', chisquare.mean( k ) );
+console.log( 'Median: %d', roundn( chisquare.median( k ), -4 ) );
+console.log( 'Mode: %d', chisquare.mode( k ) );
+console.log( 'Variance: %d', chisquare.variance( k ) );
+console.log( 'Standard Deviation: %d', roundn( chisquare.stdev( k ), -4 ) );
+console.log( 'Skewness: %d', roundn( chisquare.skewness( k ), -4 ) );
+console.log( 'Excess Kurtosis: %d', roundn( chisquare.kurtosis( k ), -4 ) );
+console.log( 'Entropy: %d', roundn( chisquare.entropy( k ), -4 ) );
+
+// Evaluate probability functions:
+var x = 3.0;
+console.log( '\nEvaluating at x = %d', x );
+console.log( 'PDF: %d', roundn( chisquare.pdf( x, k ), -4 ) );
+console.log( 'logPDF: %d', roundn( chisquare.logpdf( x, k ), -4 ) );
+console.log( 'CDF: %d', roundn( chisquare.cdf( x, k ), -4 ) );
+
+// Calculate quantiles:
+var p = 0.7;
+console.log( '\nQuantile at p = %d: %d', p, roundn( chisquare.quantile( p, k ), -4 ) );
+
+// Evaluate moment-generating function:
+var t = 0.1;
+console.log( 'MGF at t = %d: %d', t, roundn( chisquare.mgf( t, k ), -4 ) );