166 lines
7.0 KiB
Markdown
166 lines
7.0 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Geometric
|
||
|
|
|
||
|
|
> Geometric distribution.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var geometric = require( '@stdlib/stats/base/dists/geometric' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### geometric
|
||
|
|
|
||
|
|
Geometric distribution.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var dist = geometric;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
The namespace contains the following distribution functions:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*+(cdf|pmf|mgf|quantile)*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`cdf( x, p )`][@stdlib/stats/base/dists/geometric/cdf]</span><span class="delimiter">: </span><span class="description">geometric distribution cumulative distribution function.</span>
|
||
|
|
- <span class="signature">[`logcdf( x, p )`][@stdlib/stats/base/dists/geometric/logcdf]</span><span class="delimiter">: </span><span class="description">geometric distribution logarithm of cumulative distribution function.</span>
|
||
|
|
- <span class="signature">[`logpmf( x, p )`][@stdlib/stats/base/dists/geometric/logpmf]</span><span class="delimiter">: </span><span class="description">geometric distribution logarithm of probability mass function (PMF).</span>
|
||
|
|
- <span class="signature">[`mgf( t, p )`][@stdlib/stats/base/dists/geometric/mgf]</span><span class="delimiter">: </span><span class="description">geometric distribution moment-generating function (MGF).</span>
|
||
|
|
- <span class="signature">[`pmf( x, p )`][@stdlib/stats/base/dists/geometric/pmf]</span><span class="delimiter">: </span><span class="description">geometric distribution probability mass function (PMF).</span>
|
||
|
|
- <span class="signature">[`quantile( r, p )`][@stdlib/stats/base/dists/geometric/quantile]</span><span class="delimiter">: </span><span class="description">geometric distribution quantile function.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains the following functions for calculating distribution properties:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`entropy( p )`][@stdlib/stats/base/dists/geometric/entropy]</span><span class="delimiter">: </span><span class="description">geometric distribution entropy.</span>
|
||
|
|
- <span class="signature">[`kurtosis( p )`][@stdlib/stats/base/dists/geometric/kurtosis]</span><span class="delimiter">: </span><span class="description">geometric distribution excess kurtosis.</span>
|
||
|
|
- <span class="signature">[`mean( p )`][@stdlib/stats/base/dists/geometric/mean]</span><span class="delimiter">: </span><span class="description">geometric distribution expected value.</span>
|
||
|
|
- <span class="signature">[`median( p )`][@stdlib/stats/base/dists/geometric/median]</span><span class="delimiter">: </span><span class="description">geometric distribution median.</span>
|
||
|
|
- <span class="signature">[`mode( p )`][@stdlib/stats/base/dists/geometric/mode]</span><span class="delimiter">: </span><span class="description">geometric distribution mode.</span>
|
||
|
|
- <span class="signature">[`skewness( p )`][@stdlib/stats/base/dists/geometric/skewness]</span><span class="delimiter">: </span><span class="description">geometric distribution skewness.</span>
|
||
|
|
- <span class="signature">[`stdev( p )`][@stdlib/stats/base/dists/geometric/stdev]</span><span class="delimiter">: </span><span class="description">geometric distribution standard deviation.</span>
|
||
|
|
- <span class="signature">[`variance( p )`][@stdlib/stats/base/dists/geometric/variance]</span><span class="delimiter">: </span><span class="description">geometric distribution variance.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains a constructor function for creating a [geometric][geometric-distribution] distribution object.
|
||
|
|
|
||
|
|
<!-- <toc pattern="*ctor*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`Geometric( [p] )`][@stdlib/stats/base/dists/geometric/ctor]</span><span class="delimiter">: </span><span class="description">geometric distribution constructor.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Geometric = require( '@stdlib/stats/base/dists/geometric' ).Geometric;
|
||
|
|
|
||
|
|
var dist = new Geometric( 0.2 );
|
||
|
|
|
||
|
|
var y = dist.logpmf( 3.0 );
|
||
|
|
// returns ~-2.279
|
||
|
|
|
||
|
|
y = dist.logpmf( 2.3 );
|
||
|
|
// returns -Infinity
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var geometric = require( '@stdlib/stats/base/dists/geometric' );
|
||
|
|
|
||
|
|
console.log( objectKeys( geometric ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[geometric-distribution]: https://en.wikipedia.org/wiki/Geometric_distribution
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/ctor
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/entropy
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/kurtosis
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/mean
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/median]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/median
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/mode
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/skewness
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/stdev
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/variance
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/cdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/logcdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/logcdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/logpmf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/logpmf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/mgf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/mgf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/pmf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/pmf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/geometric/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric/quantile
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|