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

Cosine

Raised cosine distribution.

Usage

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

cosine

Raised cosine distribution.

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

The namespace contains the following distribution functions:

• cdf( x, mu, s ): raised cosine distribution cumulative distribution function.
• logcdf( x, mu, s ): evaluate the natural logarithm of the cumulative distribution function (CDF) for a raised cosine distribution.
• logpdf( x, mu, s ): raised cosine distribution logarithm of probability density function (PDF).
• mgf( t, mu, s ): raised cosine distribution moment-generating function.
• pdf( x, mu, s ): raised cosine distribution probability density function (PDF).
• quantile( p, mu, s ): raised cosine distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• kurtosis( mu, s ): raised cosine distribution excess kurtosis.
• mean( mu, s ): raised cosine distribution expected value.
• median( mu, s ): raised cosine distribution median.
• mode( mu, s ): raised cosine distribution mode.
• skewness( mu, s ): raised cosine distribution skewness.
• stdev( mu, s ): raised cosine distribution standard deviation.
• variance( mu, s ): raised cosine distribution variance.

The namespace contains a constructor function for creating a raised cosine distribution object.

• Cosine( [mu, s] ): raised cosine distribution constructor.

var Cosine = require( '@stdlib/stats/base/dists/cosine' ).Cosine;

var dist = new Cosine( 2.0, 4.0 );

var y = dist.cdf( 0.5 );
// returns ~0.165

Examples

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

console.log( objectKeys( cosine ) );