Class BetaPrimeDistribution

Provides generation of beta-prime distributed random numbers.

Inheritance

System.Object

Distribution

BetaPrimeDistribution

Inherited Members

Distribution.CanReset

Distribution.Generator

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Experior.Core.Mathematics.Statistics.Generators.Continuous

Assembly: Experior.Core.dll

Syntax

public class BetaPrimeDistribution : Distribution

Remarks

The implementation of the BetaPrimeDistribution type bases upon information presented on Xycoon - Inverted Beta Distribution.

Constructors

BetaPrimeDistribution()

Initializes a new instance of the BetaPrimeDistribution class, using a StandardGenerator as underlying random number generator.

Declaration

public BetaPrimeDistribution()

BetaPrimeDistribution(Generator)

Initializes a new instance of the BetaPrimeDistribution class, using the specified Generator as underlying random number generator.

Declaration

public BetaPrimeDistribution(Generator generator)

Parameters

Type	Name	Description
Generator	generator	A Generator object.

Properties

Alpha

Gets or sets the parameter alpha which is used for generation of beta-prime distributed random numbers.

Declaration

public double Alpha { get; set; }

Property Value

Type	Description
System.Double	The alpha.

Remarks

Call IsValidAlpha(Double) to determine whether a value is valid and therefor assignable.

Beta

Gets or sets the parameter beta which is used for generation of beta-prime distributed random numbers.

Declaration

public double Beta { get; set; }

Property Value

Type	Description
System.Double	The beta.

Remarks

Call IsValidBeta(Double) to determine whether a value is valid and therefor assignable.

Maximum

Gets the maximum possible value of beta-prime distributed random numbers.

Declaration

public override double Maximum { get; }

Property Value

Type	Description
System.Double	The maximum.

Overrides

Distribution.Maximum

Mean

Gets the mean value of beta-prime distributed random numbers.

Declaration

public override double Mean { get; }

Property Value

Type	Description
System.Double	The mean.

Overrides

Distribution.Mean

Median

Gets the median of beta-prime distributed random numbers.

Declaration

public override double Median { get; }

Property Value

Type	Description
System.Double	The median.

Overrides

Distribution.Median

Minimum

Gets the minimum possible value of beta-prime distributed random numbers.

Declaration

public override double Minimum { get; }

Property Value

Type	Description
System.Double	The minimum.

Overrides

Distribution.Minimum

Mode

Gets the mode of beta-prime distributed random numbers.

Declaration

public override double[] Mode { get; }

Property Value

Type	Description
System.Double[]	The mode.

Overrides

Distribution.Mode

Variance

Gets the variance of beta-prime distributed random numbers.

Declaration

public override double Variance { get; }

Property Value

Type	Description
System.Double	The variance.

Overrides

Distribution.Variance

Methods

IsValidAlpha(Double)

Determines whether the specified value is valid for parameter Alpha.

Declaration

public bool IsValidAlpha(double value)

Parameters

Type	Name	Description
System.Double	value	The value to check.

Returns

Type	Description
System.Boolean	true if value is greater than 1.0; otherwise, false.

IsValidBeta(Double)

Determines whether the specified value is valid for parameter Beta.

Declaration

public bool IsValidBeta(double value)

Parameters

Type	Name	Description
System.Double	value	The value to check.

Returns

Type	Description
System.Boolean	true if value is greater than 1.0; otherwise, false.

NextDouble()

Returns a beta-prime distributed floating point random number.

Declaration

public override double NextDouble()

Returns

Type	Description
System.Double	A beta-prime distributed double-precision floating point number.

Overrides

Distribution.NextDouble()

Reset()

Resets the beta-prime distribution, so that it produces the same random number sequence again.

Declaration

public override bool Reset()

Returns

Type	Description
System.Boolean	true, if the beta-prime distribution was reset; otherwise, false.

Overrides

Distribution.Reset()