About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Cumulative Distribution Function
Chi-squared distribution cumulative distribution function.
Installation
npm install @stdlib/stats-base-dists-chisquare-cdf
Usage
var cdf = require( '@stdlib/stats-base-dists-chisquare-cdf' );
cdf( x, k )
Evaluates the cumulative distribution function (CDF) for a chi-squared distribution with degrees of freedom k
.
var y = cdf( 2.0, 1.0 );
y = cdf( 2.0, 3.0 );
y = cdf( 1.0, 0.5 );
y = cdf( -1.0, 2.0 );
y = cdf( -Infinity, 4.0 );
y = cdf( +Infinity, 4.0 );
If provided NaN
as any argument, the function returns NaN
.
var y = cdf( NaN, 1.0 );
y = cdf( 0.0, NaN );
If provided k < 0
, the function returns NaN
.
var y = cdf( 2.0, -2.0 );
If provided k = 0
, the function evaluates the CDF of a degenerate distribution centered at 0
.
var y = cdf( 2.0, 0.0 );
y = cdf( -2.0, 0.0 );
y = cdf( 0.0, 0.0 );
cdf.factory( k )
Returns a function for evaluating the cumulative distribution function for a chi-squared distribution with degrees of freedom k
.
var mycdf = cdf.factory( 3.0 );
var y = mycdf( 6.0 );
y = mycdf( 1.5 );
Examples
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var cdf = require( '@stdlib/stats-base-dists-chisquare-cdf' );
var k;
var x;
var y;
var i;
for ( i = 0; i < 20; i++ ) {
x = randu() * 10.0;
k = round( randu()*5.0 );
y = cdf( x, k );
console.log( 'x: %d, k: %d, F(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
}
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
License
See LICENSE.
Copyright
Copyright © 2016-2023. The Stdlib Authors.
0.1.0 (2023-09-24)
<section class="features">
Features
81ca3ab
- update minimum TypeScript version
</section>
<!-- /.features -->
<section class="breaking-changes">
BREAKING CHANGES
</section>
<!-- /.breaking-changes -->
<section class="commits">
Commits
<details>
81ca3ab
- feat: update minimum TypeScript version (by Philipp Burckhardt)d5fa8e8
- test: use strictEqual checks (by Philipp Burckhardt)37f032d
- docs: render equations via math code blocks (by Philipp Burckhardt)
</details>
</section>
<!-- /.commits -->
<section class="contributors">
Contributors
A total of 1 person contributed to this release. Thank you to this contributor:
</section>
<!-- /.contributors -->
</section>
<!-- /.release -->
<section class="release" id="v0.0.7">