README.md (5889B)
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 # Lévy 22 23 > Lévy distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var levy = require( '@stdlib/stats/base/dists/levy' ); 31 ``` 32 33 #### levy 34 35 Lévy distribution. 36 37 ```javascript 38 var dist = levy; 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, mu, c )`][@stdlib/stats/base/dists/levy/cdf]</span><span class="delimiter">: </span><span class="description">Lévy distribution cumulative distribution function.</span> 49 - <span class="signature">[`logcdf( x, mu, c )`][@stdlib/stats/base/dists/levy/logcdf]</span><span class="delimiter">: </span><span class="description">Lévy distribution logarithm of cumulative distribution function.</span> 50 - <span class="signature">[`logpdf( x, mu, c )`][@stdlib/stats/base/dists/levy/logpdf]</span><span class="delimiter">: </span><span class="description">Lévy distribution logarithm of probability density function (PDF).</span> 51 - <span class="signature">[`pdf( x, mu, c )`][@stdlib/stats/base/dists/levy/pdf]</span><span class="delimiter">: </span><span class="description">Lévy distribution probability density function (PDF).</span> 52 - <span class="signature">[`quantile( p, mu, c )`][@stdlib/stats/base/dists/levy/quantile]</span><span class="delimiter">: </span><span class="description">Lévy distribution quantile function.</span> 53 54 </div> 55 56 <!-- </toc> --> 57 58 The namespace contains the following functions for calculating distribution properties: 59 60 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> --> 61 62 <div class="namespace-toc"> 63 64 - <span class="signature">[`entropy( mu, c )`][@stdlib/stats/base/dists/levy/entropy]</span><span class="delimiter">: </span><span class="description">Lévy distribution differential entropy.</span> 65 - <span class="signature">[`mean( mu, c )`][@stdlib/stats/base/dists/levy/mean]</span><span class="delimiter">: </span><span class="description">Lévy distribution expected value.</span> 66 - <span class="signature">[`median( mu, c )`][@stdlib/stats/base/dists/levy/median]</span><span class="delimiter">: </span><span class="description">Lévy distribution median.</span> 67 - <span class="signature">[`mode( mu, c )`][@stdlib/stats/base/dists/levy/mode]</span><span class="delimiter">: </span><span class="description">Lévy distribution mode.</span> 68 - <span class="signature">[`stdev( mu, c )`][@stdlib/stats/base/dists/levy/stdev]</span><span class="delimiter">: </span><span class="description">Lévy distribution standard deviation.</span> 69 - <span class="signature">[`variance( mu, c )`][@stdlib/stats/base/dists/levy/variance]</span><span class="delimiter">: </span><span class="description">Lévy distribution variance.</span> 70 71 </div> 72 73 <!-- </toc> --> 74 75 The namespace contains a constructor function for creating a [Lévy][levy-distribution] distribution object. 76 77 <!-- <toc pattern="*ctor*"> --> 78 79 <div class="namespace-toc"> 80 81 - <span class="signature">[`Levy( [mu, c] )`][@stdlib/stats/base/dists/levy/ctor]</span><span class="delimiter">: </span><span class="description">Lévy distribution constructor.</span> 82 83 </div> 84 85 <!-- </toc> --> 86 87 ```javascript 88 var Levy = require( '@stdlib/stats/base/dists/levy' ).Levy; 89 90 var dist = new Levy( 2.0, 4.0 ); 91 92 var y = dist.pdf( 2.5 ); 93 // returns ~0.041 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 levy = require( '@stdlib/stats/base/dists/levy' ); 111 112 console.log( objectKeys( levy ) ); 113 ``` 114 115 </section> 116 117 <!-- /.examples --> 118 119 <section class="links"> 120 121 [levy-distribution]: https://en.wikipedia.org/wiki/L%C3%A9vy_distribution 122 123 <!-- <toc-links> --> 124 125 [@stdlib/stats/base/dists/levy/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/ctor 126 127 [@stdlib/stats/base/dists/levy/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/entropy 128 129 [@stdlib/stats/base/dists/levy/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/mean 130 131 [@stdlib/stats/base/dists/levy/median]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/median 132 133 [@stdlib/stats/base/dists/levy/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/mode 134 135 [@stdlib/stats/base/dists/levy/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/stdev 136 137 [@stdlib/stats/base/dists/levy/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/variance 138 139 [@stdlib/stats/base/dists/levy/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/cdf 140 141 [@stdlib/stats/base/dists/levy/logcdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/logcdf 142 143 [@stdlib/stats/base/dists/levy/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/logpdf 144 145 [@stdlib/stats/base/dists/levy/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/pdf 146 147 [@stdlib/stats/base/dists/levy/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy/quantile 148 149 <!-- </toc-links> --> 150 151 </section> 152 153 <!-- /.links -->