154 lines
5.6 KiB
Markdown
154 lines
5.6 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Chi
|
||
|
|
|
||
|
|
> Chi distribution.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var chi = require( '@stdlib/stats/base/dists/chi' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### chi
|
||
|
|
|
||
|
|
Chi distribution.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var dist = chi;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
The namespace contains the following distribution functions:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`cdf( x, k )`][@stdlib/stats/base/dists/chi/cdf]</span><span class="delimiter">: </span><span class="description">Chi distribution cumulative distribution function.</span>
|
||
|
|
- <span class="signature">[`logpdf( x, k )`][@stdlib/stats/base/dists/chi/logpdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability density function (PDF) for a chi distribution .</span>
|
||
|
|
- <span class="signature">[`pdf( x, k )`][@stdlib/stats/base/dists/chi/pdf]</span><span class="delimiter">: </span><span class="description">Chi distribution probability density function (PDF).</span>
|
||
|
|
- <span class="signature">[`quantile( p, k )`][@stdlib/stats/base/dists/chi/quantile]</span><span class="delimiter">: </span><span class="description">Chi distribution quantile function.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains the following functions for calculating distribution properties:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`entropy( k )`][@stdlib/stats/base/dists/chi/entropy]</span><span class="delimiter">: </span><span class="description">Chi distribution differential entropy.</span>
|
||
|
|
- <span class="signature">[`kurtosis( k )`][@stdlib/stats/base/dists/chi/kurtosis]</span><span class="delimiter">: </span><span class="description">Chi distribution excess kurtosis.</span>
|
||
|
|
- <span class="signature">[`mean( k )`][@stdlib/stats/base/dists/chi/mean]</span><span class="delimiter">: </span><span class="description">Chi distribution expected value.</span>
|
||
|
|
- <span class="signature">[`mode( k )`][@stdlib/stats/base/dists/chi/mode]</span><span class="delimiter">: </span><span class="description">Chi distribution mode.</span>
|
||
|
|
- <span class="signature">[`skewness( k )`][@stdlib/stats/base/dists/chi/skewness]</span><span class="delimiter">: </span><span class="description">Chi distribution skewness.</span>
|
||
|
|
- <span class="signature">[`stdev( k )`][@stdlib/stats/base/dists/chi/stdev]</span><span class="delimiter">: </span><span class="description">Chi distribution standard deviation.</span>
|
||
|
|
- <span class="signature">[`variance( k )`][@stdlib/stats/base/dists/chi/variance]</span><span class="delimiter">: </span><span class="description">Chi distribution variance.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains a constructor function for creating a [Chi][chi-distribution] distribution object.
|
||
|
|
|
||
|
|
<!-- <toc pattern="*ctor*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`Chi( [k] )`][@stdlib/stats/base/dists/chi/ctor]</span><span class="delimiter">: </span><span class="description">Chi distribution constructor.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Chi = require( '@stdlib/stats/base/dists/chi' ).Chi;
|
||
|
|
|
||
|
|
var dist = new Chi( 4.0 );
|
||
|
|
|
||
|
|
var mu = dist.mean;
|
||
|
|
// returns ~1.88
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var chi = require( '@stdlib/stats/base/dists/chi' );
|
||
|
|
|
||
|
|
console.log( objectKeys( chi ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[chi-distribution]: https://en.wikipedia.org/wiki/Chi_distribution
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/ctor
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/entropy
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/kurtosis
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/mean
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/mode
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/skewness
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/stdev
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/variance
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/cdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/logpdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/pdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/chi/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/quantile
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|