com.compomics.util.math.statistics.distributions

Class NonSymmetricalNormalDistribution

java.lang.Object

com.compomics.util.math.statistics.distributions.NonSymmetricalNormalDistribution

All Implemented Interfaces:

Distribution, Serializable

public class NonSymmetricalNormalDistribution
extends Object
implements Distribution

This class represents a non symmetrical normal distribution.

Author:

Marc Vaudel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NonSymmetricalNormalDistribution(double mean, double stdDown, double stdUp) Constructor.

Method Summary

Methods

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	getMean() Returns the mean of the distribution.
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.
static NonSymmetricalNormalDistribution	getRobustNonSymmetricalNormalDistribution(ArrayList<Double> input) Returns the non-symmetrical distribution of the input list of double calibrated on the median, 15.9% and 84.1% percentiles.
double	getStdDown() Returns the standard deviation to the left of the distribution.
double	getStdUp() Returns the standard deviation to the right of the distribution.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NonSymmetricalNormalDistribution

public NonSymmetricalNormalDistribution(double mean,
                                double stdDown,
                                double stdUp)

Constructor.

Parameters:

mean - the mean

stdDown - the standard deviation on the left of the mean

stdUp - the standard deviation on the right of the mean

Method Detail

getStdUp

public double getStdUp()

Returns the standard deviation to the right of the distribution.

Returns:

the standard deviation to the right of the distribution

getStdDown

public double getStdDown()

Returns the standard deviation to the left of the distribution.

Returns:

the standard deviation to the left of the distribution

getMean

public double getMean()

Returns the mean of the distribution.

Returns:

the mean of the distribution

getRobustNonSymmetricalNormalDistribution

public static NonSymmetricalNormalDistribution getRobustNonSymmetricalNormalDistribution(ArrayList<Double> input)

Returns the non-symmetrical distribution of the input list of double calibrated on the median, 15.9% and 84.1% percentiles.

Parameters:

input - the input list

Returns:

the non symmetrical distribution calibrated on the median, 15.9% and 84.1% percentiles.

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

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

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

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