org.jscience.mathematics.statistics
Class ParetoDistribution

java.lang.Object
  extended by org.jscience.mathematics.statistics.Distribution
      extended by org.jscience.mathematics.statistics.ParetoDistribution
All Implemented Interfaces:
java.io.Serializable

public class ParetoDistribution
extends Distribution
implements java.io.Serializable

This class models the Pareto distribution with a specified parameter.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jscience.mathematics.statistics.Distribution
CONTINUOUS, DISCRETE, MIXED
 
Constructor Summary
ParetoDistribution()
          The default constructor creates a new Pareto distribution with parameter 1.
ParetoDistribution(double a)
          This general constructor creates a new Pareto distribuiton with a specified parameter.
 
Method Summary
 double getCDF(double x)
          This method comptues the cumulative distribution function.
 double getDensity(double x)
          This method computes the probability density function.
 double getMaxDensity()
          This method returns the maximum value of the probability density function.
 double getMGF(double t)
          This method returns the moment generating function.
 double getMoment(double a, int n)
          This method computes the moment of a specified order about a specified point.
 double getMoment(int n)
          This method computes the moment of a specified order.
 double getParameter()
          This method returns the parameter.
 double getQuantile(double p)
          This method computes the quantile function.
 double getVariance()
          This method computes the variance of the distribution.
 void setParameter(double a)
          This method sets the parameter and computes the default domain.
 java.lang.String toString()
          This method returns a string that gives the name of the distribution and the values of the parameters.
 
Methods inherited from class org.jscience.mathematics.statistics.Distribution
getDomain, getFailureRate, getMean, getMedian, getPGF, getSD, getType, setDomain, setDomain, simulate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParetoDistribution

public ParetoDistribution(double a)
This general constructor creates a new Pareto distribuiton with a specified parameter.

Parameters:
a - the parameter

ParetoDistribution

public ParetoDistribution()
The default constructor creates a new Pareto distribution with parameter 1.

Method Detail

setParameter

public void setParameter(double a)
This method sets the parameter and computes the default domain.

Parameters:
a - the parameter

getParameter

public double getParameter()
This method returns the parameter.

Returns:
DOCUMENT ME!

getDensity

public double getDensity(double x)
This method computes the probability density function.

Specified by:
getDensity in class Distribution
Parameters:
x - a number in the domain of the distribution
Returns:
the probability density at x

getMaxDensity

public double getMaxDensity()
This method returns the maximum value of the probability density function.

Overrides:
getMaxDensity in class Distribution
Returns:
the maximum value of the probability density function

getMoment

public double getMoment(int n)
This method computes the moment of a specified order.

Overrides:
getMoment in class Distribution
Parameters:
n - the order
Returns:
the moment of order n

getMoment

public double getMoment(double a,
                        int n)
This method computes the moment of a specified order about a specified point.

Overrides:
getMoment in class Distribution
Parameters:
a - the center
n - the order
Returns:
the moment of order n about a

getMGF

public double getMGF(double t)
This method returns the moment generating function.

Overrides:
getMGF in class Distribution
Parameters:
t - a real number
Returns:
the moment generating function at t

getVariance

public double getVariance()
This method computes the variance of the distribution.

Overrides:
getVariance in class Distribution
Returns:
the variance

getCDF

public double getCDF(double x)
This method comptues the cumulative distribution function.

Overrides:
getCDF in class Distribution
Parameters:
x - a number in the domain of the distribution
Returns:
the cumulative probability at x

getQuantile

public double getQuantile(double p)
This method computes the quantile function.

Overrides:
getQuantile in class Distribution
Parameters:
p - a number in (0, 1)
Returns:
the quantile of order p

toString

public java.lang.String toString()
This method returns a string that gives the name of the distribution and the values of the parameters.

Overrides:
toString in class Distribution
Returns:
a string giving the name of the distribution and the values of the parameters