com.compomics.util.math.statistics.ditributions

Class NormalDistribution

java.lang.Object

com.compomics.util.math.statistics.ditributions.NormalDistribution

All Implemented Interfaces:

Distribution

public class NormalDistribution
extends java.lang.Object
implements Distribution

This class represents a normal distribution. A dirac distribution if the standard deviation is null.

Author:

Marc Vaudel

Constructor Summary

Constructors

Constructor and Description
NormalDistribution(double mean, double std) Constructor.

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.
static NormalDistribution	getNormalDistribution(java.util.ArrayList<java.lang.Double> input) Returns the normal distribution corresponding to a given list of double calibrated on mean and standard deviation.
java.lang.Double	getProbabilityAt(double x) Returns the density function value at a given position.
static NormalDistribution	getRobustNormalDistribution(java.util.ArrayList<java.lang.Double> input) Returns the normal distribution corresponding to a given list of double calibrated on median and 34.1% percentile to median distance
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalDistribution

public NormalDistribution(double mean,
                  double std)

Constructor.

Parameters:

mean - the mean

std - the standard deviation

Method Detail

getNormalDistribution

public static NormalDistribution getNormalDistribution(java.util.ArrayList<java.lang.Double> input)

Returns the normal distribution corresponding to a given list of double calibrated on mean and standard deviation.

Parameters:

input - the input as a list of double

Returns:

the normal distribution calibrated on the mean and standard deviation

getRobustNormalDistribution

public static NormalDistribution getRobustNormalDistribution(java.util.ArrayList<java.lang.Double> input)

Returns the normal distribution corresponding to a given list of double calibrated on median and 34.1% percentile to median distance

Parameters:

input - the input as list of double

Returns:

a normal distribution calibrated on median and 34.1% percentile to median distance

getProbabilityAt

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

getMaxValueForProbability

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

getCumulativeProbabilityAt

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

getValueAtCumulativeProbability

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

getDescendingCumulativeProbabilityAt

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

getValueAtDescendingCumulativeProbability

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