README.md (5759B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Chi 22 23 > Chi distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var chi = require( '@stdlib/stats/base/dists/chi' ); 31 ``` 32 33 #### chi 34 35 Chi distribution. 36 37 ```javascript 38 var dist = chi; 39 // returns {...} 40 ``` 41 42 The namespace contains the following distribution functions: 43 44 <!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> --> 45 46 <div class="namespace-toc"> 47 48 - <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> 49 - <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> 50 - <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> 51 - <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> 52 53 </div> 54 55 <!-- </toc> --> 56 57 The namespace contains the following functions for calculating distribution properties: 58 59 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> --> 60 61 <div class="namespace-toc"> 62 63 - <span class="signature">[`entropy( k )`][@stdlib/stats/base/dists/chi/entropy]</span><span class="delimiter">: </span><span class="description">Chi distribution differential entropy.</span> 64 - <span class="signature">[`kurtosis( k )`][@stdlib/stats/base/dists/chi/kurtosis]</span><span class="delimiter">: </span><span class="description">Chi distribution excess kurtosis.</span> 65 - <span class="signature">[`mean( k )`][@stdlib/stats/base/dists/chi/mean]</span><span class="delimiter">: </span><span class="description">Chi distribution expected value.</span> 66 - <span class="signature">[`mode( k )`][@stdlib/stats/base/dists/chi/mode]</span><span class="delimiter">: </span><span class="description">Chi distribution mode.</span> 67 - <span class="signature">[`skewness( k )`][@stdlib/stats/base/dists/chi/skewness]</span><span class="delimiter">: </span><span class="description">Chi distribution skewness.</span> 68 - <span class="signature">[`stdev( k )`][@stdlib/stats/base/dists/chi/stdev]</span><span class="delimiter">: </span><span class="description">Chi distribution standard deviation.</span> 69 - <span class="signature">[`variance( k )`][@stdlib/stats/base/dists/chi/variance]</span><span class="delimiter">: </span><span class="description">Chi distribution variance.</span> 70 71 </div> 72 73 <!-- </toc> --> 74 75 The namespace contains a constructor function for creating a [Chi][chi-distribution] distribution object. 76 77 <!-- <toc pattern="*ctor*"> --> 78 79 <div class="namespace-toc"> 80 81 - <span class="signature">[`Chi( [k] )`][@stdlib/stats/base/dists/chi/ctor]</span><span class="delimiter">: </span><span class="description">Chi distribution constructor.</span> 82 83 </div> 84 85 <!-- </toc> --> 86 87 ```javascript 88 var Chi = require( '@stdlib/stats/base/dists/chi' ).Chi; 89 90 var dist = new Chi( 4.0 ); 91 92 var mu = dist.mean; 93 // returns ~1.88 94 ``` 95 96 </section> 97 98 <!-- /.usage --> 99 100 <section class="examples"> 101 102 ## Examples 103 104 <!-- TODO: better examples --> 105 106 <!-- eslint no-undef: "error" --> 107 108 ```javascript 109 var objectKeys = require( '@stdlib/utils/keys' ); 110 var chi = require( '@stdlib/stats/base/dists/chi' ); 111 112 console.log( objectKeys( chi ) ); 113 ``` 114 115 </section> 116 117 <!-- /.examples --> 118 119 <section class="links"> 120 121 [chi-distribution]: https://en.wikipedia.org/wiki/Chi_distribution 122 123 <!-- <toc-links> --> 124 125 [@stdlib/stats/base/dists/chi/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/ctor 126 127 [@stdlib/stats/base/dists/chi/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/entropy 128 129 [@stdlib/stats/base/dists/chi/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/kurtosis 130 131 [@stdlib/stats/base/dists/chi/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/mean 132 133 [@stdlib/stats/base/dists/chi/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/mode 134 135 [@stdlib/stats/base/dists/chi/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/skewness 136 137 [@stdlib/stats/base/dists/chi/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/stdev 138 139 [@stdlib/stats/base/dists/chi/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/variance 140 141 [@stdlib/stats/base/dists/chi/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/cdf 142 143 [@stdlib/stats/base/dists/chi/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/logpdf 144 145 [@stdlib/stats/base/dists/chi/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/pdf 146 147 [@stdlib/stats/base/dists/chi/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi/quantile 148 149 <!-- </toc-links> --> 150 151 </section> 152 153 <!-- /.links -->