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