umontreal.iro.lecuyer.probdist

Class HyperbolicSecantDist

java.lang.Object

umontreal.iro.lecuyer.probdist.ContinuousDistribution

umontreal.iro.lecuyer.probdist.HyperbolicSecantDist

All Implemented Interfaces:

Distribution

public class HyperbolicSecantDist
extends ContinuousDistribution

Extends the class ContinuousDistribution for the Hyperbolic Secant distribution with location parameter μ and scale parameter σ > 0. Its density is

f (x) = 1/(2σ) sech(π/2(x - μ)/σ)

The distribution function is given by

F(x) = 2/πtan^-1[exp(π/2(x - μ)/σ)]

The non-static versions of the methods cdf, barF, and inverseF call the static version of the same name.

Field Summary

Fields inherited from class umontreal.iro.lecuyer.probdist.ContinuousDistribution

decPrec

Constructor Summary

Constructors

Constructor and Description
HyperbolicSecantDist(double mu, double sigma) Constructs a hyperbolic secant distribution with parameters μ and σ.

Method Summary

Modifier and Type	Method and Description
double	barF(double x) Returns the complementary distribution function.
static double	barF(double mu, double sigma, double x) Computes the complementary distribution function of the hyperbolic secant distribution with parameters μ and σ.
double	cdf(double x) Returns the distribution function F(x).
static double	cdf(double mu, double sigma, double x) Computes the distribution function of the hyperbolic secant distribution with parameters μ and σ.
double	density(double x) Returns f (x), the density evaluated at x.
static double	density(double mu, double sigma, double x) Computes the density function for a hyperbolic secant distribution with parameters μ and σ.
static HyperbolicSecantDist	getInstanceFromMLE(double[] x, int n) Creates a new instance of a hyperbolic secant distribution with parameters μ and σ estimated using the maximum likelihood method based on the n observations x[i], i = 0, 1,…, n - 1.
double	getMean() Returns the mean.
static double	getMean(double mu, double sigma) Computes and returns the mean E[X] = μ of the hyperbolic secant distribution with parameters μ and σ.
static double[]	getMLE(double[] x, int n) Estimates the parameters (μ, σ) of the hyperbolic secant distribution using the maximum likelihood method, from the n observations x[i], i = 0, 1,…, n - 1.
double	getMu() Returns the parameter μ of this object.
double[]	getParams() Return a table containing the parameters of the current distribution.
double	getSigma() Returns the parameter σ of this object.
double	getStandardDeviation() Returns the standard deviation.
static double	getStandardDeviation(double mu, double sigma) Computes and returns the standard deviation of the hyperbolic secant distribution with parameters μ and σ.
double	getVariance() Returns the variance.
static double	getVariance(double mu, double sigma) Computes and returns the variance Var[X] = σ2 of the hyperbolic secant distribution with parameters μ and σ.
double	inverseF(double u) Returns the inverse distribution function x = F-1(u).
static double	inverseF(double mu, double sigma, double u) Computes the inverse of the hyperbolic secant distribution with parameters μ and σ.
void	setParams(double mu, double sigma) Sets the parameters μ and σ of this object.
java.lang.String	toString()

Methods inherited from class umontreal.iro.lecuyer.probdist.ContinuousDistribution

getXinf, getXsup, inverseBisection, inverseBrent, setXinf, setXsup

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperbolicSecantDist

public HyperbolicSecantDist(double mu,
                            double sigma)

Constructs a hyperbolic secant distribution with parameters μ and σ.

Method Detail

density

public double density(double x)

Description copied from class: ContinuousDistribution

Returns f (x), the density evaluated at x.

Specified by:

density in class ContinuousDistribution

Parameters:

x - value at which the density is evaluated

Returns:

density function evaluated at x

cdf

public double cdf(double x)

Description copied from interface: Distribution

Returns the distribution function F(x).

Parameters:

x - value at which the distribution function is evaluated

Returns:

distribution function evaluated at x

barF

public double barF(double x)

Description copied from class: ContinuousDistribution

Returns the complementary distribution function. The default implementation computes bar(F)(x) = 1 - F(x).

Specified by:

barF in interface Distribution

Overrides:

barF in class ContinuousDistribution

Parameters:

x - value at which the complementary distribution function is evaluated

Returns:

complementary distribution function evaluated at x

inverseF

public double inverseF(double u)

Description copied from class: ContinuousDistribution

Returns the inverse distribution function x = F^-1(u). Restrictions: u∈[0, 1].

Specified by:

inverseF in interface Distribution

Overrides:

inverseF in class ContinuousDistribution

Parameters:

u - value at which the inverse distribution function is evaluated

Returns:

the inverse distribution function evaluated at u

getMean

public double getMean()

Description copied from class: ContinuousDistribution

Returns the mean.

Specified by:

getMean in interface Distribution

Overrides:

getMean in class ContinuousDistribution

Returns:

the mean

getVariance

public double getVariance()

Description copied from class: ContinuousDistribution

Returns the variance.

Specified by:

getVariance in interface Distribution

Overrides:

getVariance in class ContinuousDistribution

Returns:

the variance

getStandardDeviation

public double getStandardDeviation()

Description copied from class: ContinuousDistribution

Returns the standard deviation.

Specified by:

getStandardDeviation in interface Distribution

Overrides:

getStandardDeviation in class ContinuousDistribution

Returns:

the standard deviation

density

public static double density(double mu,
                             double sigma,
                             double x)

Computes the density function for a hyperbolic secant distribution with parameters μ and σ.

cdf

public static double cdf(double mu,
                         double sigma,
                         double x)

Computes the distribution function of the hyperbolic secant distribution with parameters μ and σ.

barF

public static double barF(double mu,
                          double sigma,
                          double x)

Computes the complementary distribution function of the hyperbolic secant distribution with parameters μ and σ.

inverseF

public static double inverseF(double mu,
                              double sigma,
                              double u)

Computes the inverse of the hyperbolic secant distribution with parameters μ and σ.

getMLE

public static double[] getMLE(double[] x,
                              int n)

Estimates the parameters (μ, σ) of the hyperbolic secant distribution using the maximum likelihood method, from the n observations x[i], i = 0, 1,…, n - 1. The estimates are returned in a two-element array, in regular order: [μ, σ].

Parameters:

x - the list of observations to use to evaluate parameters

n - the number of observations to use to evaluate parameters

Returns:

returns the parameters [hat(μ), hat(σ)]

getInstanceFromMLE

public static HyperbolicSecantDist getInstanceFromMLE(double[] x,
                                                      int n)

Creates a new instance of a hyperbolic secant distribution with parameters μ and σ estimated using the maximum likelihood method based on the n observations x[i], i = 0, 1,…, n - 1.

Parameters:

x - the list of observations to use to evaluate parameters

n - the number of observations to use to evaluate parameters

getMean

public static double getMean(double mu,
                             double sigma)

Computes and returns the mean E[X] = μ of the hyperbolic secant distribution with parameters μ and σ.

Returns:

the mean of the hyperbolic secant distribution E[X] = μ

getVariance

public static double getVariance(double mu,
                                 double sigma)

Computes and returns the variance Var[X] = σ² of the hyperbolic secant distribution with parameters μ and σ.

Returns:

the variance of the hyperbolic secant distribution Var[X] = σ²

getStandardDeviation

public static double getStandardDeviation(double mu,
                                          double sigma)

Computes and returns the standard deviation of the hyperbolic secant distribution with parameters μ and σ.

Returns:

the standard deviation of the hyperbolic secant distribution

getMu

public double getMu()

Returns the parameter μ of this object.

getSigma

public double getSigma()

Returns the parameter σ of this object.

setParams

public void setParams(double mu,
                      double sigma)

Sets the parameters μ and σ of this object.

getParams

public double[] getParams()

Return a table containing the parameters of the current distribution. This table is put in regular order: [μ, σ].

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object