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