## Types in MathNet.Numerics.Distributions

Type InverseGamma

Namespace MathNet.Numerics.Distributions

Interfaces IContinuousDistribution

Continuous Univariate Inverse Gamma distribution. The inverse Gamma distribution is a distribution over the positive real numbers parameterized by two positive parameters..

### Public Constructors

#### InverseGamma(double shape, double scale, Random randomSource)

Initializes a new instance of the InverseGamma class.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

###### `Random` randomSource

The random number generator which is used to draw random samples.

#### InverseGamma(double shape, double scale)

Initializes a new instance of the InverseGamma class.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

### Public Static Functions

#### doubleCDF(double shape, double scale, double x)

Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

###### `double` x

The location at which to compute the cumulative distribution function.

##### Return
###### `double`

the cumulative distribution at location x.

#### boolIsValidParameterSet(double shape, double scale)

Tests whether the provided values are valid parameters for this distribution.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

#### doublePDF(double shape, double scale, double x)

Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

###### `double` x

The location at which to compute the density.

##### Return
###### `double`

the density at x.

#### doublePDFLn(double shape, double scale, double x)

Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

###### `double` x

The location at which to compute the density.

##### Return
###### `double`

the log density at x.

#### doubleSample(Random rnd, double shape, double scale)

Generates a sample from the distribution.
##### Parameters
###### `Random` rnd

The random number generator to use.

###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `double`

a sample from the distribution.

#### doubleSample(double shape, double scale)

Generates a sample from the distribution.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `double`

a sample from the distribution.

#### voidSamples(Double[] values, double shape, double scale)

Fills an array with samples generated from the distribution.
##### Parameters
###### `Double[]` values

The array to fill with the samples.

###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `void`

a sequence of samples from the distribution.

#### IEnumerable<double>Samples(Random rnd, double shape, double scale)

Generates a sequence of samples from the distribution.
##### Parameters
###### `Random` rnd

The random number generator to use.

###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `IEnumerable<double>`

a sequence of samples from the distribution.

#### voidSamples(Random rnd, Double[] values, double shape, double scale)

Fills an array with samples generated from the distribution.
##### Parameters
###### `Random` rnd

The random number generator to use.

###### `Double[]` values

The array to fill with the samples.

###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `void`

a sequence of samples from the distribution.

#### IEnumerable<double>Samples(double shape, double scale)

Generates a sequence of samples from the distribution.
##### Parameters
###### `double` shape

The shape (α) of the distribution. Range: α > 0.

###### `double` scale

The scale (β) of the distribution. Range: β > 0.

##### Return
###### `IEnumerable<double>`

a sequence of samples from the distribution.

### Public Methods

#### doubleCumulativeDistribution(double x)

Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
##### Parameters
###### `double` x

The location at which to compute the cumulative distribution function.

##### Return
###### `double`

the cumulative distribution at location x.

#### doubleDensity(double x)

Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
##### Parameters
###### `double` x

The location at which to compute the density.

##### Return
###### `double`

the density at x.

#### doubleDensityLn(double x)

Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
##### Parameters
###### `double` x

The location at which to compute the log density.

##### Return
###### `double`

the log density at x.

#### doubleSample()

Draws a random sample from the distribution.
##### Return
###### `double`

A random number from this distribution.

#### IEnumerable<double>Samples()

Generates a sequence of samples from the Cauchy distribution.
##### Return
###### `IEnumerable<double>`

a sequence of samples from the distribution.

#### voidSamples(Double[] values)

Fills an array with samples generated from the distribution.

#### stringToString()

A string representation of the distribution.
##### Return
###### `string`

a string representation of the distribution.

### Public Properties

#### doubleEntropy get;

Gets the entropy of the distribution.

#### doubleMaximum get;

Gets the maximum of the distribution.

#### doubleMean get;

Gets the mean of the distribution.

#### doubleMedian get;

Gets the median of the distribution.
Throws NotSupportedException.

#### doubleMinimum get;

Gets the minimum of the distribution.

#### doubleMode get;

Gets the mode of the distribution.

#### RandomRandomSource get; set;

Gets or sets the random number generator which is used to draw random samples.

#### doubleScale get;

Gets or sets The scale (β) parameter. Range: β > 0.

#### doubleShape get;

Gets or sets the shape (α) parameter. Range: α > 0.

#### doubleSkewness get;

Gets the skewness of the distribution.

#### doubleStdDev get;

Gets the standard deviation of the distribution.

#### doubleVariance get;

Gets the variance of the distribution.