Click or drag to resize

NegativeBinomial Class

Negative binomial discrete univariate distribution class. http://en.wikipedia.org/wiki/Negative_binomial_distribution
Inheritance Hierarchy
SystemObject
  FinMath.Statistics.DistributionsDUDistribution
    FinMath.Statistics.DistributionsNegativeBinomial

Namespace:  FinMath.Statistics.Distributions
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
[SerializableAttribute]
public class NegativeBinomial : DUDistribution

The NegativeBinomial type exposes the following members.

Constructors
  NameDescription
Public methodNegativeBinomial(Int32, Double)
Creates new instance of NegativeBinomial with user specified parameters.
Public methodNegativeBinomial(RandomGenerator, Int32, Double)
Creates new istance of NegativeBinomial with user specified parameters and generator.
Top
Properties
  NameDescription
Public propertyEntropy
Entropy of the distribution. http://en.wikipedia.org/wiki/Information_entropy
(Inherited from DUDistribution.)
Public propertyKurtosis
Excess Kurtosis of distribution. http://en.wikipedia.org/wiki/Excess_kurtosis
(Overrides DUDistributionKurtosis.)
Public propertyMean
Mean of the distribution. http://en.wikipedia.org/wiki/Expected_value
(Overrides DUDistributionMean.)
Public propertyMedian
Median of distribution. http://en.wikipedia.org/wiki/Median
(Inherited from DUDistribution.)
Public propertyMode
Mode of distribution. http://en.wikipedia.org/wiki/Mode_(statistics)
(Overrides DUDistributionMode.)
Public propertyNumberOfFailures
Number of failures until the experiment is stopped.
Public propertySkewness
Skewness of distribution. http://en.wikipedia.org/wiki/Skewness
(Overrides DUDistributionSkewness.)
Public propertyStandardDeviation
Standard deviation of the distribution. http://en.wikipedia.org/wiki/Standard_Deviation
(Inherited from DUDistribution.)
Public propertySuccessProbability
Success probability in each trial.
Public propertyVariance
Variance of the distribution. http://en.wikipedia.org/wiki/Variance
(Overrides DUDistributionVariance.)
Top
Methods
  NameDescription
Public methodCdf(Int32)
Cumulative distribution function. http://en.wikipedia.org/wiki/Cumulative_distribution_function
(Overrides DUDistributionCdf(Int32).)
Public methodStatic memberCdf(Int32, Int32, Double)
Static cumulative distribution function. http://en.wikipedia.org/wiki/Cumulative_distribution_function
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInverseCdf(Double)
Inverse cumulative distribution function. Is userful for quatile generation. Function will return random variable value such that probability that distribution sample will get value less than or equal to returned value is equal to specified probability. Note. Handle special cases pvalue = 0 and pvalue = 1 separately if results Int32.MinValue and Int32.MaxValue respectively are not expected ones.
(Inherited from DUDistribution.)
Public methodStatic memberInverseCdf(Double, Int32, Double)
Inverse cumulative distribution function. Is useful for quantile calculation. Function will return value of random variable such that likelihood for this random variable to occur less than or equal to returned value equal to specified pvalue parameter.
Public methodPmf(Int32)
Probability mass function. http://en.wikipedia.org/wiki/Probability_mass_function
(Overrides DUDistributionPmf(Int32).)
Public methodStatic memberPmf(Int32, Int32, Double)
Static probability mass function. http://en.wikipedia.org/wiki/Probability_mass_function
Public methodSample
Generate random variable sample.
(Overrides DUDistributionSample.)
Public methodSample(Int32)
Generate series of random variable samples.
(Inherited from DUDistribution.)
Public methodSample(Int32)
Fill in array with random variable series.
(Overrides DUDistributionSample(Int32).)
Public methodStatic memberSample(Int32, Double)
Static method which generates new sample of negative binomial distribution variate with specified parameters.
Public methodStatic memberSample(RandomGenerator, Int32, Double)
Static method which generates new sample of negative binomial distribution variate with specified parameters.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also