|
| 1 | +<!-- |
| 2 | +
|
| 3 | +@license Apache-2.0 |
| 4 | +
|
| 5 | +Copyright (c) 2025 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 | +# Planck |
| 22 | + |
| 23 | +> Planck distribution. |
| 24 | +
|
| 25 | +<section class="usage"> |
| 26 | + |
| 27 | +## Usage |
| 28 | + |
| 29 | +```javascript |
| 30 | +var planck = require( '@stdlib/stats/base/dists/planck' ); |
| 31 | +``` |
| 32 | + |
| 33 | +#### planck |
| 34 | + |
| 35 | +Planck distribution. |
| 36 | + |
| 37 | +```javascript |
| 38 | +var dist = planck; |
| 39 | +// returns {...} |
| 40 | +``` |
| 41 | + |
| 42 | +The namespace contains the following distribution functions: |
| 43 | + |
| 44 | +<!-- <toc pattern="*+(cdf|pmf|mgf|quantile)*"> --> |
| 45 | + |
| 46 | +<div class="namespace-toc"> |
| 47 | + |
| 48 | +- <span class="signature">[`cdf( x, lambda )`][@stdlib/stats/base/dists/planck/cdf]</span><span class="delimiter">: </span><span class="description">Planck distribution cumulative distribution function.</span> |
| 49 | +- <span class="signature">[`logcdf( x, lambda )`][@stdlib/stats/base/dists/planck/logcdf]</span><span class="delimiter">: </span><span class="description">Planck distribution logarithm of cumulative distribution function.</span> |
| 50 | +- <span class="signature">[`logpmf( x, lambda )`][@stdlib/stats/base/dists/planck/logpmf]</span><span class="delimiter">: </span><span class="description">Planck distribution logarithm of probability mass function (PMF).</span> |
| 51 | +- <span class="signature">[`mgf( t, lambda )`][@stdlib/stats/base/dists/planck/mgf]</span><span class="delimiter">: </span><span class="description">Planck distribution moment-generating function (MGF).</span> |
| 52 | +- <span class="signature">[`pmf( x, lambda )`][@stdlib/stats/base/dists/planck/pmf]</span><span class="delimiter">: </span><span class="description">Planck distribution probability mass function (PMF).</span> |
| 53 | +- <span class="signature">[`quantile( r, lambda )`][@stdlib/stats/base/dists/planck/quantile]</span><span class="delimiter">: </span><span class="description">Planck 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( lambda )`][@stdlib/stats/base/dists/planck/entropy]</span><span class="delimiter">: </span><span class="description">Planck distribution entropy.</span> |
| 66 | +- <span class="signature">[`kurtosis( lambda )`][@stdlib/stats/base/dists/planck/kurtosis]</span><span class="delimiter">: </span><span class="description">Planck distribution excess kurtosis.</span> |
| 67 | +- <span class="signature">[`mean( lambda )`][@stdlib/stats/base/dists/planck/mean]</span><span class="delimiter">: </span><span class="description">Planck distribution expected value.</span> |
| 68 | +- <span class="signature">[`median( lambda )`][@stdlib/stats/base/dists/planck/median]</span><span class="delimiter">: </span><span class="description">Planck distribution median.</span> |
| 69 | +- <span class="signature">[`mode( lambda )`][@stdlib/stats/base/dists/planck/mode]</span><span class="delimiter">: </span><span class="description">Planck distribution mode.</span> |
| 70 | +- <span class="signature">[`skewness( lambda )`][@stdlib/stats/base/dists/planck/skewness]</span><span class="delimiter">: </span><span class="description">Planck distribution skewness.</span> |
| 71 | +- <span class="signature">[`stdev( lambda )`][@stdlib/stats/base/dists/planck/stdev]</span><span class="delimiter">: </span><span class="description">Planck distribution standard deviation.</span> |
| 72 | +- <span class="signature">[`variance( lambda )`][@stdlib/stats/base/dists/planck/variance]</span><span class="delimiter">: </span><span class="description">Planck distribution variance.</span> |
| 73 | + |
| 74 | +</div> |
| 75 | + |
| 76 | +<!-- </toc> --> |
| 77 | + |
| 78 | +</section> |
| 79 | + |
| 80 | +<!-- /.usage --> |
| 81 | + |
| 82 | +<section class="examples"> |
| 83 | + |
| 84 | +## Examples |
| 85 | + |
| 86 | +<!-- eslint no-undef: "error" --> |
| 87 | + |
| 88 | +```javascript |
| 89 | +var objectKeys = require( '@stdlib/utils/keys' ); |
| 90 | +var planck = require( '@stdlib/stats/base/dists/planck' ); |
| 91 | + |
| 92 | +console.log( objectKeys( planck ) ); |
| 93 | +``` |
| 94 | + |
| 95 | +</section> |
| 96 | + |
| 97 | +<!-- /.examples --> |
| 98 | + |
| 99 | +<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> |
| 100 | + |
| 101 | +<section class="related"> |
| 102 | + |
| 103 | +</section> |
| 104 | + |
| 105 | +<!-- /.related --> |
| 106 | + |
| 107 | +<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> |
| 108 | + |
| 109 | +<section class="links"> |
| 110 | + |
| 111 | +[@stdlib/stats/base/dists/planck/cdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/cdf |
| 112 | + |
| 113 | +[@stdlib/stats/base/dists/planck/entropy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/entropy |
| 114 | + |
| 115 | +[@stdlib/stats/base/dists/planck/kurtosis]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/kurtosis |
| 116 | + |
| 117 | +[@stdlib/stats/base/dists/planck/logcdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf |
| 118 | + |
| 119 | +[@stdlib/stats/base/dists/planck/logpmf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf |
| 120 | + |
| 121 | +[@stdlib/stats/base/dists/planck/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/mean |
| 122 | + |
| 123 | +[@stdlib/stats/base/dists/planck/median]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/median |
| 124 | + |
| 125 | +[@stdlib/stats/base/dists/planck/mgf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/mgf |
| 126 | + |
| 127 | +[@stdlib/stats/base/dists/planck/mode]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/mode |
| 128 | + |
| 129 | +[@stdlib/stats/base/dists/planck/pmf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/pmf |
| 130 | + |
| 131 | +[@stdlib/stats/base/dists/planck/quantile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/quantile |
| 132 | + |
| 133 | +[@stdlib/stats/base/dists/planck/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/skewness |
| 134 | + |
| 135 | +[@stdlib/stats/base/dists/planck/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/stdev |
| 136 | + |
| 137 | +[@stdlib/stats/base/dists/planck/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/planck/variance |
| 138 | + |
| 139 | +</section> |
| 140 | + |
| 141 | +<!-- /.links --> |
0 commit comments