com.compomics.util.math.statistics

Interface Distribution

All Known Implementing Classes:

NonSymmetricalNormalDistribution, NormalDistribution

public interface Distribution

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

Author:

Marc Vaudel

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getCumulativeProbabilityAt(double x) Returns the cumulative density function value at a given position.
java.lang.Double	getDescendingCumulativeProbabilityAt(double x) Returns the cumulative density function value at a given position when starting from the high values.
java.lang.Double	getMaxValueForProbability(double p) The value after which the density function will be smaller than p.
java.lang.Double	getMinValueForProbability(double p) The value before which the density function will be smaller than p.
java.lang.Double	getProbabilityAt(double x) Returns the density function value at a given position.
java.lang.Double	getValueAtCumulativeProbability(double p) The value after which the cumulative density function will be smaller than p.
java.lang.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

java.lang.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

java.lang.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

getDescendingCumulativeProbabilityAt

java.lang.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

getMaxValueForProbability

java.lang.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

java.lang.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

java.lang.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

getValueAtDescendingCumulativeProbability

java.lang.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