Catalano.Statistics.Distributions

Class BernoulliDistribution

java.lang.Object

Catalano.Statistics.Distributions.BernoulliDistribution

All Implemented Interfaces:

IDiscreteDistribution

public class BernoulliDistribution
extends java.lang.Object
implements IDiscreteDistribution

Bernoulli probability distribution. The Bernoulli distribution is a distribution for a single binary variable x E {0,1}, representing, for example, the flipping of a coin. It is governed by a single continuous parameter representing the probability of an observation to be equal to 1.

Constructor Summary

Constructors

Constructor and Description
BernoulliDistribution(double mean) Initializes a new instance of the BernoulliDistribution class.

Method Summary

Modifier and Type	Method and Description
double	DistributionFunction(int k) Gets the cumulative distribution function (cdf) for this distribution evaluated at point k.
double	Entropy() Gets the entropy for this distribution.
double	LogProbabilityMassFunction(int k) Gets the log-probability mass function (pmf) for this distribution evaluated at point x.
double	Mean() Gets the mean for this distribution.
double	ProbabilityMassFunction(int k) Gets the probability mass function (pmf) for this distribution evaluated at point x.
double	Variance() Gets the variance for this distribution.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BernoulliDistribution

public BernoulliDistribution(double mean)

Initializes a new instance of the BernoulliDistribution class.

Parameters:

mean - The probability of an observation being equal to 1.

Method Detail

Mean

public double Mean()

Description copied from interface: IDiscreteDistribution

Gets the mean for this distribution.

Specified by:

Mean in interface IDiscreteDistribution

Returns:

Mean.

Variance

public double Variance()

Description copied from interface: IDiscreteDistribution

Gets the variance for this distribution.

Specified by:

Variance in interface IDiscreteDistribution

Returns:

Variance.

Entropy

public double Entropy()

Description copied from interface: IDiscreteDistribution

Gets the entropy for this distribution.

Specified by:

Entropy in interface IDiscreteDistribution

Returns:

Entropy.

DistributionFunction

public double DistributionFunction(int k)

Description copied from interface: IDiscreteDistribution

Gets the cumulative distribution function (cdf) for this distribution evaluated at point k. The Cumulative Distribution Function (CDF) describes the cumulative probability that a given value or any value smaller than it will occur.

Specified by:

DistributionFunction in interface IDiscreteDistribution

Parameters:

k - A single point in the distribution range.

Returns:

Result.

ProbabilityMassFunction

public double ProbabilityMassFunction(int k)

Description copied from interface: IDiscreteDistribution

Gets the probability mass function (pmf) for this distribution evaluated at point x. The Probability Mass Function (PMF) describes the probability that a given value k will occur.

Specified by:

ProbabilityMassFunction in interface IDiscreteDistribution

Parameters:

k - A single point in the distribution range.

Returns:

The probability of k occurring in the current distribution.

LogProbabilityMassFunction

public double LogProbabilityMassFunction(int k)

Description copied from interface: IDiscreteDistribution

Gets the log-probability mass function (pmf) for this distribution evaluated at point x. The Probability Mass Function (PMF) describes the probability that a given value k will occur.

Specified by:

LogProbabilityMassFunction in interface IDiscreteDistribution

Parameters:

k - A single point in the distribution range.

Returns:

The logarithm of the probability of k occurring in the current distribution.