time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/triangular/README.md

Triangular

Triangular distribution.

Usage

var triangular = require( '@stdlib/stats/base/dists/triangular' );

triangular

Triangular distribution.

var dist = triangular;
// returns {...}

The namespace contains the following distribution functions:

• cdf( x, a, b, c ): triangular distribution cumulative distribution function.
• logcdf( x, a, b, c ): triangular distribution logarithm of cumulative distribution function.
• logpdf( x, a, b, c ): triangular distribution logarithm of probability density function (PDF).
• mgf( t, a, b, c ): triangular distribution moment-generating function (MGF).
• pdf( x, a, b, c ): triangular distribution probability density function (PDF).
• quantile( p, a, b, c ): triangular distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• entropy( a, b, c ): triangular distribution differential entropy.
• kurtosis( a, b, c ): triangular distribution excess kurtosis.
• mean( a, b, c ): triangular distribution expected value.
• median( a, b, c ): triangular distribution median.
• mode( a, b, c ): triangular distribution mode.
• skewness( a, b, c ): triangular distribution skewness.
• stdev( a, b, c ): triangular distribution standard deviation.
• variance( a, b, c ): triangular distribution variance.

The namespace contains a constructor function for creating a triangular distribution object.

• Triangular( [a, b, c] ): triangular distribution constructor.

var Triangular = require( '@stdlib/stats/base/dists/triangular' ).Triangular;

var dist = new Triangular( 2.0, 4.0, 3.0 );

var y = dist.quantile( 0.5 );
// returns 3.0

y = dist.quantile( 1.9 );
// returns NaN

Examples

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

console.log( objectKeys( triangular ) );