README.md (5364B)
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 # Fisher's F 22 23 > Fisher's F distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var f = require( '@stdlib/stats/base/dists/f' ); 31 ``` 32 33 #### f 34 35 Fisher's F distribution. 36 37 ```javascript 38 var dist = f; 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, d1, d2 )`][@stdlib/stats/base/dists/f/cdf]</span><span class="delimiter">: </span><span class="description">F distribution cumulative distribution function.</span> 49 - <span class="signature">[`pdf( x, d1, d2 )`][@stdlib/stats/base/dists/f/pdf]</span><span class="delimiter">: </span><span class="description">F distribution probability density function (PDF).</span> 50 - <span class="signature">[`quantile( p, d1, d2 )`][@stdlib/stats/base/dists/f/quantile]</span><span class="delimiter">: </span><span class="description">F distribution quantile function.</span> 51 52 </div> 53 54 <!-- </toc> --> 55 56 The namespace contains the following functions for calculating distribution properties: 57 58 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> --> 59 60 <div class="namespace-toc"> 61 62 - <span class="signature">[`entropy( d1, d2 )`][@stdlib/stats/base/dists/f/entropy]</span><span class="delimiter">: </span><span class="description">F distribution differential entropy.</span> 63 - <span class="signature">[`kurtosis( d1, d2 )`][@stdlib/stats/base/dists/f/kurtosis]</span><span class="delimiter">: </span><span class="description">F distribution excess kurtosis.</span> 64 - <span class="signature">[`mean( d1, d2 )`][@stdlib/stats/base/dists/f/mean]</span><span class="delimiter">: </span><span class="description">F distribution expected value.</span> 65 - <span class="signature">[`mode( d1, d2 )`][@stdlib/stats/base/dists/f/mode]</span><span class="delimiter">: </span><span class="description">F distribution mode.</span> 66 - <span class="signature">[`skewness( d1, d2 )`][@stdlib/stats/base/dists/f/skewness]</span><span class="delimiter">: </span><span class="description">F distribution skewness.</span> 67 - <span class="signature">[`stdev( d1, d2 )`][@stdlib/stats/base/dists/f/stdev]</span><span class="delimiter">: </span><span class="description">F distribution standard deviation.</span> 68 - <span class="signature">[`variance( d1, d2 )`][@stdlib/stats/base/dists/f/variance]</span><span class="delimiter">: </span><span class="description">F distribution variance.</span> 69 70 </div> 71 72 <!-- </toc> --> 73 74 The namespace contains a constructor function for creating a [Fisher's F][f-distribution] distribution object. 75 76 <!-- <toc pattern="*ctor*"> --> 77 78 <div class="namespace-toc"> 79 80 - <span class="signature">[`F( [d1, d2] )`][@stdlib/stats/base/dists/f/ctor]</span><span class="delimiter">: </span><span class="description">F distribution constructor.</span> 81 82 </div> 83 84 <!-- </toc> --> 85 86 ```javascript 87 var F = require( '@stdlib/stats/base/dists/f' ).F; 88 89 var dist = new F( 2.0, 4.0 ); 90 91 var y = dist.cdf( 0.5 ); 92 // returns ~0.36 93 ``` 94 95 </section> 96 97 <!-- /.usage --> 98 99 <section class="examples"> 100 101 ## Examples 102 103 <!-- TODO: better examples --> 104 105 <!-- eslint no-undef: "error" --> 106 107 ```javascript 108 var objectKeys = require( '@stdlib/utils/keys' ); 109 var f = require( '@stdlib/stats/base/dists/f' ); 110 111 console.log( objectKeys( f ) ); 112 ``` 113 114 </section> 115 116 <!-- /.examples --> 117 118 <section class="links"> 119 120 [f-distribution]: https://en.wikipedia.org/wiki/F_distribution 121 122 <!-- <toc-links> --> 123 124 [@stdlib/stats/base/dists/f/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/ctor 125 126 [@stdlib/stats/base/dists/f/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/entropy 127 128 [@stdlib/stats/base/dists/f/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/kurtosis 129 130 [@stdlib/stats/base/dists/f/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/mean 131 132 [@stdlib/stats/base/dists/f/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/mode 133 134 [@stdlib/stats/base/dists/f/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/skewness 135 136 [@stdlib/stats/base/dists/f/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/stdev 137 138 [@stdlib/stats/base/dists/f/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/variance 139 140 [@stdlib/stats/base/dists/f/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/cdf 141 142 [@stdlib/stats/base/dists/f/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/pdf 143 144 [@stdlib/stats/base/dists/f/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f/quantile 145 146 <!-- </toc-links> --> 147 148 </section> 149 150 <!-- /.links -->