npm package: @stdlib/stats-base-dists
Description: Base (i.e., lower-level) probability distributions.
Author: The Stdlib Authors
Latest version: 0.3.1

<!--

@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.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# Probability Distributions

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Base (i.e., lower-level) probability distribution modules.

<section class="installation">

## Installation

```bash
npm install @stdlib/stats-base-dists
```

</section>

<section class="usage">

## Usage

```javascript
var dists = require( '@stdlib/stats-base-dists' );
```

#### dists

Namespace containing "base" (i.e., lower-level) probability distribution modules.

```javascript
var distributions = dists;
// returns {...}
```

### Continuous Distributions

<!-- <toc keywords="+continuous, -discrete"> -->

<div class="namespace-toc">

-   <span class="signature">[`arcsine`][@stdlib/stats/base/dists/arcsine]</span><span class="delimiter">: </span><span class="description">arcsine distribution.</span>
-   <span class="signature">[`beta`][@stdlib/stats/base/dists/beta]</span><span class="delimiter">: </span><span class="description">beta distribution.</span>
-   <span class="signature">[`betaprime`][@stdlib/stats/base/dists/betaprime]</span><span class="delimiter">: </span><span class="description">beta prime distribution.</span>
-   <span class="signature">[`bradford`][@stdlib/stats/base/dists/bradford]</span><span class="delimiter">: </span><span class="description">bradford distribution.</span>
-   <span class="signature">[`cauchy`][@stdlib/stats/base/dists/cauchy]</span><span class="delimiter">: </span><span class="description">Cauchy distribution.</span>
-   <span class="signature">[`chi`][@stdlib/stats/base/dists/chi]</span><span class="delimiter">: </span><span class="description">Chi distribution.</span>
-   <span class="signature">[`chisquare`][@stdlib/stats/base/dists/chisquare]</span><span class="delimiter">: </span><span class="description">Chi-squared distribution.</span>
-   <span class="signature">[`cosine`][@stdlib/stats/base/dists/cosine]</span><span class="delimiter">: </span><span class="description">raised cosine distribution.</span>
-   <span class="signature">[`erlang`][@stdlib/stats/base/dists/erlang]</span><span class="delimiter">: </span><span class="description">Erlang distribution.</span>
-   <span class="signature">[`exponential`][@stdlib/stats/base/dists/exponential]</span><span class="delimiter">: </span><span class="description">exponential distribution.</span>
-   <span class="signature">[`f`][@stdlib/stats/base/dists/f]</span><span class="delimiter">: </span><span class="description">fisher's F distribution.</span>
-   <span class="signature">[`frechet`][@stdlib/stats/base/dists/frechet]</span><span class="delimiter">: </span><span class="description">Fréchet distribution.</span>
-   <span class="signature">[`gamma`][@stdlib/stats/base/dists/gamma]</span><span class="delimiter">: </span><span class="description">gamma distribution.</span>
-   <span class="signature">[`gumbel`][@stdlib/stats/base/dists/gumbel]</span><span class="delimiter">: </span><span class="description">Gumbel distribution.</span>
-   <span class="signature">[`invgamma`][@stdlib/stats/base/dists/invgamma]</span><span class="delimiter">: </span><span class="description">inverse gamma distribution.</span>
-   <span class="signature">[`kumaraswamy`][@stdlib/stats/base/dists/kumaraswamy]</span><span class="delimiter">: </span><span class="description">Kumaraswamy's double bounded distribution.</span>
-   <span class="signature">[`laplace`][@stdlib/stats/base/dists/laplace]</span><span class="delimiter">: </span><span class="description">Laplace distribution.</span>
-   <span class="signature">[`levy`][@stdlib/stats/base/dists/levy]</span><span class="delimiter">: </span><span class="description">Lévy distribution.</span>
-   <span class="signature">[`logistic`][@stdlib/stats/base/dists/logistic]</span><span class="delimiter">: </span><span class="description">logistic distribution.</span>
-   <span class="signature">[`lognormal`][@stdlib/stats/base/dists/lognormal]</span><span class="delimiter">: </span><span class="description">lognormal distribution.</span>
-   <span class="signature">[`normal`][@stdlib/stats/base/dists/normal]</span><span class="delimiter">: </span><span class="description">normal distribution.</span>
-   <span class="signature">[`pareto1`][@stdlib/stats/base/dists/pareto-type1]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution.</span>
-   <span class="signature">[`rayleigh`][@stdlib/stats/base/dists/rayleigh]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution.</span>
-   <span class="signature">[`signrank`][@stdlib/stats/base/dists/signrank]</span><span class="delimiter">: </span><span class="description">distribution of the Wilcoxon signed rank test statistic.</span>
-   <span class="signature">[`tukey`][@stdlib/stats/base/dists/studentized-range]</span><span class="delimiter">: </span><span class="description">Studentized range distribution.</span>
-   <span class="signature">[`t`][@stdlib/stats/base/dists/t]</span><span class="delimiter">: </span><span class="description">Student's t distribution.</span>
-   <span class="signature">[`triangular`][@stdlib/stats/base/dists/triangular]</span><span class="delimiter">: </span><span class="description">triangular distribution.</span>
-   <span class="signature">[`truncatedNormal`][@stdlib/stats/base/dists/truncated-normal]</span><span class="delimiter">: </span><span class="description">truncated normal distribution.</span>
-   <span class="signature">[`uniform`][@stdlib/stats/base/dists/uniform]</span><span class="delimiter">: </span><span class="description">continuous uniform distribution.</span>

</div>

<!-- </toc> -->

### Discrete Distributions

<!-- <toc keywords="-continuous, +discrete"> -->

<div class="namespace-toc">

-   <span class="signature">[`bernoulli`][@stdlib/stats/base/dists/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution.</span>
-   <span class="signature">[`binomial`][@stdlib/stats/base/dists/binomial]</span><span class="delimiter">: </span><span class="description">binomial distribution.</span>
-   <span class="signature">[`discreteUniform`][@stdlib/stats/base/dists/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution.</span>
-   <span class="signature">[`geometric`][@stdlib/stats/base/dists/geometric]</span><span class="delimiter">: </span><span class="description">geometric distribution.</span>
-   <span class="signature">[`hypergeometric`][@stdlib/stats/base/dists/hypergeometric]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution.</span>
-   <span class="signature">[`negativeBinomial`][@stdlib/stats/base/dists/negative-binomial]</span><span class="delimiter">: </span><span class="description">negative binomial distribution.</span>
-   <span class="signature">[`planck`][@stdlib/stats/base/dists/planck]</span><span class="delimiter">: </span><span class="description">planck distribution.</span>
-   <span class="signature">[`poisson`][@stdlib/stats/base/dists/poisson]</span><span class="delimiter">: </span><span class="description">Poisson distribution.</span>

</div>

<!-- </toc> -->

### Other

<!-- <toc keywords="+degenerate"> -->

<div class="namespace-toc">

-   <span class="signature">[`degenerate`][@stdlib/stats/base/dists/degenerate]</span><span class="delimiter">: </span><span class="description">degenerate distribution.</span>

</div>

<!-- </toc> -->

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils-keys' );
var dists = require( '@stdlib/stats-base-dists' );

console.log( objectKeys( dists ) );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists

[test-image]: https://github.com/stdlib-js/stats-base-dists/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/stats-base-dists/actions/workflows/test.yml?query=branch:v0.3.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-dists.svg
[dependencies-url]: https://david-dm.org/stdlib-js/stats-base-dists/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/stats-base-dists/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists/main/LICENSE

<!-- <toc-links> -->

[@stdlib/stats/base/dists/degenerate]: https://www.npmjs.com/package/@stdlib/stats-base-dists-degenerate

[@stdlib/stats/base/dists/bernoulli]: https://www.npmjs.com/package/@stdlib/stats-base-dists-bernoulli

[@stdlib/stats/base/dists/binomial]: https://www.npmjs.com/package/@stdlib/stats-base-dists-binomial

[@stdlib/stats/base/dists/discrete-uniform]: https://www.npmjs.com/package/@stdlib/stats-base-dists-discrete-uniform

[@stdlib/stats/base/dists/geometric]: https://www.npmjs.com/package/@stdlib/stats-base-dists-geometric

[@stdlib/stats/base/dists/hypergeometric]: https://www.npmjs.com/package/@stdlib/stats-base-dists-hypergeometric

[@stdlib/stats/base/dists/negative-binomial]: https://www.npmjs.com/package/@stdlib/stats-base-dists-negative-binomial

[@stdlib/stats/base/dists/planck]: https://www.npmjs.com/package/@stdlib/stats-base-dists-planck

[@stdlib/stats/base/dists/poisson]: https://www.npmjs.com/package/@stdlib/stats-base-dists-poisson

[@stdlib/stats/base/dists/arcsine]: https://www.npmjs.com/package/@stdlib/stats-base-dists-arcsine

[@stdlib/stats/base/dists/beta]: https://www.npmjs.com/package/@stdlib/stats-base-dists-beta

[@stdlib/stats/base/dists/betaprime]: https://www.npmjs.com/package/@stdlib/stats-base-dists-betaprime

[@stdlib/stats/base/dists/bradford]: https://www.npmjs.com/package/@stdlib/stats-base-dists-bradford

[@stdlib/stats/base/dists/cauchy]: https://www.npmjs.com/package/@stdlib/stats-base-dists-cauchy

[@stdlib/stats/base/dists/chi]: https://www.npmjs.com/package/@stdlib/stats-base-dists-chi

[@stdlib/stats/base/dists/chisquare]: https://www.npmjs.com/package/@stdlib/stats-base-dists-chisquare

[@stdlib/stats/base/dists/cosine]: https://www.npmjs.com/package/@stdlib/stats-base-dists-cosine

[@stdlib/stats/base/dists/erlang]: https://www.npmjs.com/package/@stdlib/stats-base-dists-erlang

[@stdlib/stats/base/dists/exponential]: https://www.npmjs.com/package/@stdlib/stats-base-dists-exponential

[@stdlib/stats/base/dists/f]: https://www.npmjs.com/package/@stdlib/stats-base-dists-f

[@stdlib/stats/base/dists/frechet]: https://www.npmjs.com/package/@stdlib/stats-base-dists-frechet

[@stdlib/stats/base/dists/gamma]: https://www.npmjs.com/package/@stdlib/stats-base-dists-gamma

[@stdlib/stats/base/dists/gumbel]: https://www.npmjs.com/package/@stdlib/stats-base-dists-gumbel

[@stdlib/stats/base/dists/invgamma]: https://www.npmjs.com/package/@stdlib/stats-base-dists-invgamma

[@stdlib/stats/base/dists/kumaraswamy]: https://www.npmjs.com/package/@stdlib/stats-base-dists-kumaraswamy

[@stdlib/stats/base/dists/laplace]: https://www.npmjs.com/package/@stdlib/stats-base-dists-laplace

[@stdlib/stats/base/dists/levy]: https://www.npmjs.com/package/@stdlib/stats-base-dists-levy

[@stdlib/stats/base/dists/logistic]: https://www.npmjs.com/package/@stdlib/stats-base-dists-logistic

[@stdlib/stats/base/dists/lognormal]: https://www.npmjs.com/package/@stdlib/stats-base-dists-lognormal

[@stdlib/stats/base/dists/normal]: https://www.npmjs.com/package/@stdlib/stats-base-dists-normal

[@stdlib/stats/base/dists/pareto-type1]: https://www.npmjs.com/package/@stdlib/stats-base-dists-pareto-type1

[@stdlib/stats/base/dists/rayleigh]: https://www.npmjs.com/package/@stdlib/stats-base-dists-rayleigh

[@stdlib/stats/base/dists/signrank]: https://www.npmjs.com/package/@stdlib/stats-base-dists-signrank

[@stdlib/stats/base/dists/studentized-range]: https://www.npmjs.com/package/@stdlib/stats-base-dists-studentized-range

[@stdlib/stats/base/dists/t]: https://www.npmjs.com/package/@stdlib/stats-base-dists-t

[@stdlib/stats/base/dists/triangular]: https://www.npmjs.com/package/@stdlib/stats-base-dists-triangular

[@stdlib/stats/base/dists/truncated-normal]: https://www.npmjs.com/package/@stdlib/stats-base-dists-truncated-normal

[@stdlib/stats/base/dists/uniform]: https://www.npmjs.com/package/@stdlib/stats-base-dists-uniform

<!-- </toc-links> -->

</section>

<!-- /.links -->