de.lmu.ifi.dbs.elki.math.statistics.distribution

Class LaplaceDistribution

java.lang.Object

de.lmu.ifi.dbs.elki.math.statistics.distribution.AbstractDistribution

de.lmu.ifi.dbs.elki.math.statistics.distribution.LaplaceDistribution

All Implemented Interfaces:

Distribution

@Alias(value="DoubleExponentialDistribution")
public class LaplaceDistribution
extends AbstractDistribution

Laplace distribution also known as double exponential distribution

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LaplaceDistribution.Parameterizer Parameterization class

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	location Location parameter.
(package private) double	rate Rate, inverse of mean

Fields inherited from class de.lmu.ifi.dbs.elki.math.statistics.distribution.AbstractDistribution

random

Constructor Summary

Constructors

Constructor and Description
LaplaceDistribution(double rate) Constructor.
LaplaceDistribution(double rate, double location) Constructor.
LaplaceDistribution(double rate, double location, Random random) Constructor.
LaplaceDistribution(double rate, double location, RandomFactory random) Constructor.
LaplaceDistribution(double rate, Random random) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	cdf(double val) Return the cumulative density function at the given value.
static double	cdf(double val, double rate) Cumulative density, static version
double	nextRandom() This method currently uses the naive approach of returning -log(uniform).
double	pdf(double val) Return the density of an existing value
static double	pdf(double val, double rate) PDF, static version
double	quantile(double val) Quantile aka probit (for normal) aka inverse CDF (invcdf, cdf^-1) function.
static double	quantile(double val, double rate, double location) Quantile function, static version
String	toString() Describe the distribution

Methods inherited from class java.lang.Object

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

Field Detail

rate

double rate

Rate, inverse of mean

location

double location

Location parameter.

Constructor Detail

LaplaceDistribution

public LaplaceDistribution(double rate)

Constructor.

Parameters:

rate - Rate parameter (1/scale)

LaplaceDistribution

public LaplaceDistribution(double rate,
                   double location)

Constructor.

Parameters:

rate - Rate parameter (1/scale)

location - Location parameter

LaplaceDistribution

public LaplaceDistribution(double rate,
                   Random random)

Constructor.

Parameters:

rate - Rate parameter (1/scale)

random - Random generator

LaplaceDistribution

public LaplaceDistribution(double rate,
                   double location,
                   Random random)

Constructor.

Parameters:

rate - Rate parameter (1/scale)

location - Location parameter

random - Random generator

LaplaceDistribution

public LaplaceDistribution(double rate,
                   double location,
                   RandomFactory random)

Constructor.

Parameters:

rate - Rate parameter (1/scale)

location - Location parameter

random - Random generator

Method Detail

pdf

public double pdf(double val)

Description copied from interface: Distribution

Return the density of an existing value

Parameters:

val - existing value

Returns:

distribution density

pdf

public static double pdf(double val,
         double rate)

PDF, static version

Parameters:

val - Value to compute PDF at

rate - Rate parameter (1/scale)

Returns:

probability density

cdf

public double cdf(double val)

Description copied from interface: Distribution

Return the cumulative density function at the given value.

Parameters:

val - existing value

Returns:

cumulative density

cdf

public static double cdf(double val,
         double rate)

Cumulative density, static version

Parameters:

val - Value to compute CDF at

rate - Rate parameter (1/scale)

Returns:

cumulative density

quantile

public double quantile(double val)

Description copied from interface: Distribution

Quantile aka probit (for normal) aka inverse CDF (invcdf, cdf^-1) function.

Parameters:

val - Quantile to find

Returns:

Quantile position

quantile

public static double quantile(double val,
              double rate,
              double location)

Quantile function, static version

Parameters:

val - Value to compute quantile for

rate - Rate parameter

location - Location parameter

Returns:

Quantile

nextRandom

public double nextRandom()

This method currently uses the naive approach of returning -log(uniform).

Specified by:

nextRandom in interface Distribution

Overrides:

nextRandom in class AbstractDistribution

Returns:

new random value

toString

public String toString()

Description copied from interface: Distribution

Describe the distribution

Specified by:

toString in interface Distribution

Overrides:

toString in class Object

Returns:

description