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