com.compomics.util.math.statistics

Interface Distribution

All Superinterfaces:

Serializable

All Known Implementing Classes:

BinomialDistribution, NonSymmetricalNormalDistribution, NormalDistribution

public interface Distribution
extends Serializable

This class represents a statistical distribution model like a Gaussian distribution.

Author:

Marc Vaudel

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.

Method Detail

getProbabilityAt

Double getProbabilityAt(double x)

Returns the density function value at a given position.

Parameters:

x - the position of interest

Returns:

the value of the density function at the give position

getCumulativeProbabilityAt

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

Returns the cumulative density function value at a given position.

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

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

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

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

getSmallestCumulativeProbabilityAt

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

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

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

Double getMaxValueForProbability(double p)

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

Parameters:

p - the probability of interest

Returns:

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

getMinValueForProbability

Double getMinValueForProbability(double p)

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

Parameters:

p - the probability of interest

Returns:

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

getValueAtCumulativeProbability

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

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

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

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

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

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