Auto-generated commit

stdlib-js · Nov 17, 2024 · 2de1b0c · 2de1b0c
1 parent 5b37401
commit 2de1b0c
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 7 deletions.
diff --git a/.github/.keepalive b/.github/.keepalive
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,78 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-11-01)
+## Unreleased (2024-11-17)
 
-No changes reported for this release.
+<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>
+
+<!-- /.packages -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#1619](https://github.com/stdlib-js/stdlib/issues/1619)
+
+</section>
+
+<!-- /.issues -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 2 people contributed to this release. Thank you to the following contributors:
+
+-   Kohantika Nath
+-   Philipp Burckhardt
+
+</section>
+
+<!-- /.contributors -->
+
+<section class="commits">
+
+### Commits
+
+<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)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
 
 </section>
 

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -59,6 +59,7 @@ Mohammad Kaif <98884589+Kaif987@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Neeraj Pathak <neerajrpathak710@gmail.com>
 NightKnight <Ahmedatwa866@yahoo.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
@@ -69,6 +70,7 @@ Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <goswami.4@iitj.ac.in>
 Praneki <97080887+PraneGIT@users.noreply.github.com>
 Pratik <97464067+Pratik772846@users.noreply.github.com>
+Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
 Priyansh <88396544+itsspriyansh@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
 RISHAV <115060907+rishav2404@users.noreply.github.com>
@@ -79,6 +81,7 @@ Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
 Robert Gislason <gztown2216@yahoo.com>
 Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
 Rutam <138517416+performant23@users.noreply.github.com>
+Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
 SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com>

diff --git a/README.md b/README.md
@@ -141,10 +141,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>

diff --git a/examples/index.js b/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 ) );
diff --git a/package.json b/package.json
@@ -68,6 +68,7 @@
     "@stdlib/math-base-special-max": "^0.3.0",
     "@stdlib/math-base-special-pow": "^0.3.0",
     "@stdlib/math-base-special-round": "^0.3.0",
+    "@stdlib/math-base-special-roundn": "^0.2.2",
     "@stdlib/math-base-special-sqrt": "^0.2.2",
     "@stdlib/random-base-randu": "^0.2.1",
     "@stdlib/stats-base-dists-gamma-cdf": "^0.2.2",