javanpst.distributions.common.continuous

Class LaplaceDistribution

java.lang.Object

javanpst.distributions.common.continuous.LaplaceDistribution

All Implemented Interfaces:

Distribution

public class LaplaceDistribution
extends java.lang.Object
implements Distribution

A Laplace distribution.

Constructor Summary

Constructors

Constructor and Description
LaplaceDistribution() Default builder.
LaplaceDistribution(double mean, double scale) Builder.
LaplaceDistribution(LaplaceDistribution old) Copy constructor Creates a copy of a given Laplace distribution

Method Summary

Modifier and Type	Method and Description
double	computeCumulativeProbability(double x) Computes cumulative probability at a given point of the Laplace distribution.
double	computeProbability(double x) Computes mass probability at a given point of the Laplace distribution.
double	getMean() Gets the mean parameter
double	getScale() Gets the scale parameter
void	setMean(double value) Sets mean
void	setScale(double value) Sets scale Scale value must be positive
java.lang.String	toString() To String method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LaplaceDistribution

public LaplaceDistribution()

Default builder. Creates a Laplace distribution with mean 0.0 and scale 1.0

LaplaceDistribution

public LaplaceDistribution(double mean,
                           double scale)

Builder. Creates a Laplace distribution with specified mean and scale Scale must be positive

Parameters:

mean - mean of the distribution

scale - scale of the distribution

LaplaceDistribution

public LaplaceDistribution(LaplaceDistribution old)

Copy constructor Creates a copy of a given Laplace distribution

Parameters:

old - Laplace distribution to copy

Method Detail

setMean

public void setMean(double value)

Sets mean

Parameters:

value - mean value

setScale

public void setScale(double value)

Sets scale Scale value must be positive

Parameters:

value - scale value

getMean

public double getMean()

Gets the mean parameter

Returns:

value of mean

getScale

public double getScale()

Gets the scale parameter

Returns:

value of scale

computeProbability

public double computeProbability(double x)

Computes mass probability at a given point of the Laplace distribution.

Specified by:

computeProbability in interface Distribution

Parameters:

x - point selected

Returns:

mass probability at 'x'

computeCumulativeProbability

public double computeCumulativeProbability(double x)

Computes cumulative probability at a given point of the Laplace distribution.

Specified by:

computeCumulativeProbability in interface Distribution

Parameters:

x - point selected

Returns:

cumulative probability at 'x'

toString

public java.lang.String toString()

To String method.

Overrides:

toString in class java.lang.Object

Returns:

string representation of the distribution