Click or drag to resize
Accord.NET (logo)

UnivariateDiscreteDistribution Class

Abstract class for univariate discrete probability distributions.
Inheritance Hierarchy
SystemObject
  Accord.Statistics.DistributionsDistributionBase
    Accord.Statistics.Distributions.UnivariateUnivariateDiscreteDistribution
      More...

Namespace:  Accord.Statistics.Distributions.Univariate
Assembly:  Accord.Statistics (in Accord.Statistics.dll) Version: 3.5.0
Syntax
[SerializableAttribute]
public abstract class UnivariateDiscreteDistribution : DistributionBase, 
	IUnivariateDistribution<int>, IDistribution<int>, IDistribution, ICloneable, 
	IUnivariateDistribution, IUnivariateDistribution<double>, IDistribution<double>, 
	IDistribution<double[]>, ISampleableDistribution<double>, IRandomNumberGenerator<double>, 
	ISampleableDistribution<int>, IRandomNumberGenerator<int>, IFormattable
Request Example View Source

The UnivariateDiscreteDistribution type exposes the following members.

Constructors
  NameDescription
Protected methodUnivariateDiscreteDistribution
Constructs a new UnivariateDistribution class.
Top
Properties
  NameDescription
Public propertyEntropy
Gets the entropy for this distribution.
Public propertyMean
Gets the mean for this distribution.
Public propertyMedian
Gets the median for this distribution.
Public propertyMode
Gets the mode for this distribution.
Public propertyQuartiles
Gets the Quartiles for this distribution.
Public propertyStandardDeviation
Gets the Standard Deviation (the square root of the variance) for the current distribution.
Public propertySupport
Gets the support interval for this distribution.
Public propertyVariance
Gets the variance for this distribution.
Top
Methods
  NameDescription
Protected methodBaseInverseDistributionFunction
Gets the inverse of the cumulative distribution function (icdf) for this distribution evaluated at probability p using a numerical approximation based on binary search.
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from DistributionBase.)
Public methodComplementaryDistributionFunction(Int32)
Gets P(X > k) the complementary cumulative distribution function (ccdf) for this distribution evaluated at point k. This function is also known as the Survival function.
Public methodCode exampleComplementaryDistributionFunction(Int32, Boolean)
Gets the complementary cumulative distribution function (ccdf) for this distribution evaluated at point k. This function is also known as the Survival function.
Public methodCumulativeHazardFunction
Gets the cumulative hazard function for this distribution evaluated at point x.
Public methodDistributionFunction(Int32)
Gets P(X ≤ k), the cumulative distribution function (cdf) for this distribution evaluated at point k.
Public methodCode exampleDistributionFunction(Int32, Boolean)
Gets P(X ≤ k) or P(X < k), the cumulative distribution function (cdf) for this distribution evaluated at point k, depending on the value of the inclusive parameter.
Public methodDistributionFunction(Int32, Int32)
Gets the cumulative distribution function (cdf) for this distribution in the semi-closed interval (a; b] given as P(a < X ≤ b).
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFit(Double)
Fits the underlying distribution to a given set of observations.
Public methodFit(Int32)
Fits the underlying distribution to a given set of observations.
Public methodFit(Double, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodFit(Double, Double)
Fits the underlying distribution to a given set of observations.
Public methodFit(Double, Int32)
Fits the underlying distribution to a given set of observations.
Public methodFit(Int32, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodFit(Double, Double, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodFit(Double, Int32, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodFit(Int32, Double, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodFit(Int32, Int32, IFittingOptions)
Fits the underlying distribution to a given set of observations.
Public methodGenerate
Generates a random observation from the current distribution.
Public methodGenerate(Int32)
Generates a random vector of observations from the current distribution.
Public methodGenerate(Int32, Double)
Generates a random vector of observations from the current distribution.
Public methodGenerate(Int32, Int32)
Generates a random vector of observations from the current distribution.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRange
Gets the distribution range within a given percentile.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHazardFunction
Gets the hazard function, also known as the failure rate or the conditional failure density function for this distribution evaluated at point x.
Public methodInverseDistributionFunction
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 methodLogCumulativeHazardFunction
Gets the log-cumulative hazard function for this distribution evaluated at point x.
Public methodLogProbabilityMassFunction
Gets the log-probability mass function (pmf) for this distribution evaluated at point x.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProbabilityMassFunction
Gets the probability mass function (pmf) for this distribution evaluated at point x.
Public methodQuantileDensityFunction
Gets the first derivative of the inverse distribution function (icdf) for this distribution evaluated at probability p.
Public methodToString
Returns a String that represents this instance.
(Inherited from DistributionBase.)
Public methodToString(IFormatProvider)
Returns a String that represents this instance.
(Inherited from DistributionBase.)
Public methodToString(String)
Returns a String that represents this instance.
(Inherited from DistributionBase.)
Public methodToString(String, IFormatProvider)
Returns a String that represents this instance.
(Inherited from DistributionBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by Matrix.)
Top
Remarks

A probability distribution identifies either the probability of each value of an unidentified random variable (when the variable is discrete), or the probability of the value falling within a particular interval (when the variable is continuous).

The probability distribution describes the range of possible values that a random variable can attain and the probability that the value of the random variable is within any (measurable) subset of that range.

The function describing the probability that a given discrete value will occur is called the probability function (or probability mass function, abbreviated PMF), and the function describing the cumulative probability that a given value or any value smaller than it will occur is called the distribution function (or cumulative distribution function, abbreviated CDF).

References:

See Also
Inheritance Hierarchy
SystemObject
  Accord.Statistics.DistributionsDistributionBase
    Accord.Statistics.Distributions.UnivariateUnivariateDiscreteDistribution
      Accord.Statistics.Distributions.UnivariateBernoulliDistribution
      Accord.Statistics.Distributions.UnivariateBinomialDistribution
      Accord.Statistics.Distributions.UnivariateDegenerateDistribution
      Accord.Statistics.Distributions.UnivariateGeneralDiscreteDistribution
      Accord.Statistics.Distributions.UnivariateGeometricDistribution
      Accord.Statistics.Distributions.UnivariateHypergeometricDistribution
      Accord.Statistics.Distributions.UnivariateNegativeBinomialDistribution
      Accord.Statistics.Distributions.UnivariatePoissonDistribution
      Accord.Statistics.Distributions.UnivariateRademacherDistribution
      Accord.Statistics.Distributions.UnivariateSymmetricGeometricDistribution
      Accord.Statistics.Distributions.UnivariateUniformDiscreteDistribution