C# Class Accord.Statistics.Distributions.Univariate.BirnbaumSaundersDistribution

Inheritance: UnivariateContinuousDistribution

Show file Open project: accord-net/framework Class Usage Examples

Public Methods

Method	Description
BirnbaumSaundersDistribution ( ) : System	Constructs a Birnbaum-Saunders distribution with location parameter 0, scale 1, and shape 1.
BirnbaumSaundersDistribution ( [ shape ) : System	Constructs a Birnbaum-Saunders distribution with location parameter 0, scale 1, and the given shape.
BirnbaumSaundersDistribution ( [ location, [ scale, [ shape ) : System	Constructs a Birnbaum-Saunders distribution with given location, shape and scale parameters.
Clone ( ) : object	Creates a new object that is a copy of the current instance.
DistributionFunction ( double x ) : double	Gets the cumulative distribution function (cdf) for this distribution evaluated at point `x`. The Cumulative Distribution Function (CDF) describes the cumulative probability that a given value or any value smaller than it will occur.
InverseDistributionFunction ( double p ) : double	Gets the inverse of the cumulative distribution function (icdf) for this distribution evaluated at probability `p`. This function is also known as the Quantile function.
ProbabilityDensityFunction ( double x ) : double	Gets the probability density function (pdf) for this distribution evaluated at point `x`. The Probability Density Function (PDF) describes the probability that a given value `x` will occur.
ToString ( string format, IFormatProvider formatProvider ) : string	Returns a System.String that represents this instance.

Private Methods

Method	Description
init ( double location, double scale, double shape ) : void

Method Details

BirnbaumSaundersDistribution() public method

Constructs a Birnbaum-Saunders distribution with location parameter 0, scale 1, and shape 1.

public BirnbaumSaundersDistribution ( ) : System
return	System

BirnbaumSaundersDistribution() public method

Constructs a Birnbaum-Saunders distribution with location parameter 0, scale 1, and the given shape.

public BirnbaumSaundersDistribution ( [ shape ) : System
shape	[	The shape parameter gamma (γ). Default is 1.
return	System

BirnbaumSaundersDistribution() public method

Constructs a Birnbaum-Saunders distribution with given location, shape and scale parameters.

public BirnbaumSaundersDistribution ( [ location, [ scale, [ shape ) : System
location	[	The location parameter μ. Default is 0.
scale	[	The scale parameter beta (β). Default is 1.
shape	[	The shape parameter gamma (γ). Default is 1.
return	System

Clone() public method

Creates a new object that is a copy of the current instance.

public Clone ( ) : object
return	object

DistributionFunction() public method

Gets the cumulative distribution function (cdf) for this distribution evaluated at point x.

The Cumulative Distribution Function (CDF) describes the cumulative probability that a given value or any value smaller than it will occur.

public DistributionFunction ( double x ) : double
x	double	A single point in the distribution range.
return	double

InverseDistributionFunction() public method

Gets the inverse of the cumulative distribution function (icdf) for this distribution evaluated at probability p. This function is also known as the Quantile function.

public InverseDistributionFunction ( double p ) : double
p	double	A probability value between 0 and 1.
return	double

ProbabilityDensityFunction() public method

Gets the probability density function (pdf) for this distribution evaluated at point x.

The Probability Density Function (PDF) describes the probability that a given value x will occur.

public ProbabilityDensityFunction ( double x ) : double
x	double	A single point in the distribution range.
return	double

ToString() public method

Returns a System.String that represents this instance.

public ToString ( string format, IFormatProvider formatProvider ) : string
format	string
formatProvider	IFormatProvider
return	string