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