com.compomics.util.math.statistics.distributions

Class BinomialDistribution

java.lang.Object

com.compomics.util.math.statistics.distributions.BinomialDistribution

All Implemented Interfaces:

Distribution, Serializable

public class BinomialDistribution
extends Object
implements Distribution

Implementation of a binomial distribution.

Author:

Marc Vaudel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BinomialDistribution(int n, double p) Constructor.

Method Summary

Modifier and Type	Method and Description
Double	getCumulativeProbabilityAt(double x) Returns the cumulative density function value at a given position.
Double	getDescendingCumulativeProbabilityAt(double x) Returns the cumulative density function value at a given position when starting from the high values.
Double	getMaxValueForProbability(double p) The value after which the density function will be smaller than p.
Double	getMinValueForProbability(double p) The value before which the density function will be smaller than p.
Double	getProbabilityAt(double x) Returns the density function value at a given position.
Double	getSmallestCumulativeProbabilityAt(double x) Returns the cumulative density function value at a given position, starting from the low values if before the median, from the high otherwise.
Double	getValueAtCumulativeProbability(double p) The value after which the cumulative density function will be smaller than p.
Double	getValueAtDescendingCumulativeProbability(double p) The value after which the cumulative density function will be smaller than p when starting from high values.
boolean	isCacheEmpty() Indicates whether all caches are empty.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinomialDistribution

public BinomialDistribution(int n,
                            double p)

Constructor.

Parameters:

n - the number of trials

p - the probability of success of each trial

Method Detail

getProbabilityAt

public Double getProbabilityAt(double x)

Description copied from interface: Distribution

Returns the density function value at a given position.

Specified by:

getProbabilityAt in interface Distribution

Parameters:

x - the position of interest

Returns:

the value of the density function at the give position

getCumulativeProbabilityAt

public Double getCumulativeProbabilityAt(double x)
                                  throws org.apache.commons.math.MathException

Description copied from interface: Distribution

Returns the cumulative density function value at a given position.

Specified by:

getCumulativeProbabilityAt in interface Distribution

Parameters:

x - the position of interest

Returns:

the value of the density function at the give position

Throws:

org.apache.commons.math.MathException - if a MathException occurs

getDescendingCumulativeProbabilityAt

public Double getDescendingCumulativeProbabilityAt(double x)
                                            throws org.apache.commons.math.MathException

Description copied from interface: Distribution

Returns the cumulative density function value at a given position when starting from the high values.

Specified by:

getDescendingCumulativeProbabilityAt in interface Distribution

Parameters:

x - the position of interest

Returns:

the value of the density function at the give position

Throws:

org.apache.commons.math.MathException - if a MathException occurs

isCacheEmpty

public boolean isCacheEmpty()

Indicates whether all caches are empty.

Returns:

a boolean indicating whether all caches are empty

getSmallestCumulativeProbabilityAt

public Double getSmallestCumulativeProbabilityAt(double x)
                                          throws org.apache.commons.math.MathException

Description copied from interface: Distribution

Returns the cumulative density function value at a given position, starting from the low values if before the median, from the high otherwise.

Specified by:

getSmallestCumulativeProbabilityAt in interface Distribution

Parameters:

x - the position of interest

Returns:

the value of the density function at the give position

Throws:

org.apache.commons.math.MathException - if a MathException occurs

getMaxValueForProbability

public Double getMaxValueForProbability(double p)

Description copied from interface: Distribution

The value after which the density function will be smaller than p.

Specified by:

getMaxValueForProbability in interface Distribution

Parameters:

p - the probability of interest

Returns:

the value after which the density function will be smaller than p

getMinValueForProbability

public Double getMinValueForProbability(double p)

Description copied from interface: Distribution

The value before which the density function will be smaller than p.

Specified by:

getMinValueForProbability in interface Distribution

Parameters:

p - the probability of interest

Returns:

the value before which the density function will be smaller than p

getValueAtCumulativeProbability

public Double getValueAtCumulativeProbability(double p)
                                       throws org.apache.commons.math.MathException

Description copied from interface: Distribution

The value after which the cumulative density function will be smaller than p.

Specified by:

getValueAtCumulativeProbability in interface Distribution

Parameters:

p - the probability of interest

Returns:

the value after which the cumulative density function will be smaller than p

Throws:

org.apache.commons.math.MathException - if a MathException occurs

getValueAtDescendingCumulativeProbability

public Double getValueAtDescendingCumulativeProbability(double p)
                                                 throws org.apache.commons.math.MathException

Description copied from interface: Distribution

The value after which the cumulative density function will be smaller than p when starting from high values.

Specified by:

getValueAtDescendingCumulativeProbability in interface Distribution

Parameters:

p - the probability of interest

Returns:

the value after which the cumulative density function will be smaller than p

Throws:

org.apache.commons.math.MathException - if a MathException occurs