Extends the class ContinuousDistribution for the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma> 0\). More...

Inheritance diagram for HyperbolicSecantDist:

[legend]

Collaboration diagram for HyperbolicSecantDist:

[legend]

Public Member Functions
	HyperbolicSecantDist (double mu, double sigma)
	Constructs a hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

double	density (double x)

double	cdf (double x)
	Returns the distribution function \(F(x)\). More...

double	barF (double x)
	Returns \(\bar{F}(x) = 1 - F(x)\). More...

double	inverseF (double u)
	Returns the inverse distribution function \(F^{-1}(u)\), defined in ( inverseF ). More...

double	getMean ()
	Returns the mean of the distribution function.

double	getVariance ()
	Returns the variance of the distribution function.

double	getStandardDeviation ()
	Returns the standard deviation of the distribution function.

double	getMu ()
	Returns the parameter \(\mu\) of this object.

double	getSigma ()
	Returns the parameter \(\sigma\) of this object.

void	setParams (double mu, double sigma)
	Sets the parameters \(\mu\) and \(\sigma\) of this object.

double []	getParams ()
	Return a table containing the parameters of the current distribution. More...

String	toString ()
	Returns a `String` containing information about the current distribution.

Public Member Functions inherited from ContinuousDistribution
abstract double	density (double x)
	Returns \(f(x)\), the density evaluated at \(x\). More...

double	barF (double x)
	Returns the complementary distribution function. More...

double	inverseBrent (double a, double b, double u, double tol)
	Computes the inverse distribution function \(x = F^{-1}(u)\), using the Brent-Dekker method. More...

double	inverseBisection (double u)
	Computes and returns the inverse distribution function \(x = F^{-1}(u)\), using bisection. More...

double	inverseF (double u)
	Returns the inverse distribution function \(x = F^{-1}(u)\). More...

double	getMean ()
	Returns the mean. More...

double	getVariance ()
	Returns the variance. More...

double	getStandardDeviation ()
	Returns the standard deviation. More...

double	getXinf ()
	Returns \(x_a\) such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\). More...

double	getXsup ()
	Returns \(x_b\) such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\). More...

void	setXinf (double xa)
	Sets the value \(x_a=\) `xa`, such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\). More...

void	setXsup (double xb)
	Sets the value \(x_b=\) `xb`, such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\). More...

Static Public Member Functions
static double	density (double mu, double sigma, double x)
	Computes the density function ( fHyperbolicSecant ) for a hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

static double	cdf (double mu, double sigma, double x)
	Computes the distribution function of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

static double	barF (double mu, double sigma, double x)
	Computes the complementary distribution function of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

static double	inverseF (double mu, double sigma, double u)
	Computes the inverse of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

static double []	getMLE (double[] x, int n)
	Estimates the parameters \((\mu, \sigma)\) of the hyperbolic secant distribution using the maximum likelihood method, from the \(n\) observations \(x[i]\), \(i = 0, 1,…, n-1\). More...

static HyperbolicSecantDist	getInstanceFromMLE (double[] x, int n)
	Creates a new instance of a hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\) estimated using the maximum likelihood method based on the \(n\) observations \(x[i]\), \(i = 0, 1, …, n-1\). More...

static double	getMean (double mu, double sigma)
	Computes and returns the mean \(E[X] = \mu\) of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\). More...

static double	getVariance (double mu, double sigma)
	Computes and returns the variance \(\mbox{Var}[X] = \sigma^2\) of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\). More...

static double	getStandardDeviation (double mu, double sigma)
	Computes and returns the standard deviation of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\). More...

Protected Attributes
double	mu

double	sigma

Protected Attributes inherited from ContinuousDistribution
double	supportA = Double.NEGATIVE_INFINITY

double	supportB = Double.POSITIVE_INFINITY

Additional Inherited Members
Public Attributes inherited from ContinuousDistribution
int	decPrec = 15

Static Protected Attributes inherited from ContinuousDistribution
static final double	XBIG = 100.0

static final double	XBIGM = 1000.0

static final double []	EPSARRAY

Detailed Description

Extends the class ContinuousDistribution for the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma> 0\).

Its density is

\[ f(x) = \frac{1}{2 \sigma} \mbox{ sech}\left(\frac{\pi}{2} \frac{(x - \mu)}{\sigma}\right) \tag{fHyperbolicSecant} \]

The distribution function is given by

\[ F(x) = \frac{2}{\pi} \tan^{-1}\left[\exp{\left(\frac{\pi}{2} \frac{(x - \mu)}{\sigma}\right)}\right] \tag{FHyperbolicSecant} \]

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

Member Function Documentation

◆ barF()

double barF ( double x )

Returns \(\bar{F}(x) = 1 - F(x)\).

Parameters

x	value at which the complementary distribution function is evaluated

Returns: complementary distribution function evaluated at x

Implements Distribution.

◆ cdf()

double cdf ( double x )

Returns the distribution function \(F(x)\).

Parameters

x	value at which the distribution function is evaluated

Returns: distribution function evaluated at x

Implements Distribution.

◆ getInstanceFromMLE()

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

static

Creates a new instance of a hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\) 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()

static double getMean	(	double	mu,
		double	sigma
	)

static

Computes and returns the mean \(E[X] = \mu\) of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

Returns: the mean of the hyperbolic secant distribution \(E[X] = \mu\)

◆ getMLE()

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

static

Estimates the parameters \((\mu, \sigma)\) 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: [ \(\mu\), \(\sigma\)]. The estimate of the parameters is given by maximizing numerically the log-likelihood function, using the Uncmin package [211], [233] .

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{\mu}\), \(\hat{\sigma}\)]

◆ getParams()

double [] getParams ( )

Return a table containing the parameters of the current distribution.

This table is put in regular order: [ \(\mu\), \(\sigma\)].

Implements Distribution.

◆ getStandardDeviation()

static double getStandardDeviation	(	double	mu,
		double	sigma
	)

static

Computes and returns the standard deviation of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

Returns: the standard deviation of the hyperbolic secant distribution

◆ getVariance()

static double getVariance	(	double	mu,
		double	sigma
	)

static

Computes and returns the variance \(\mbox{Var}[X] = \sigma^2\) of the hyperbolic secant distribution with parameters \(\mu\) and \(\sigma\).

Returns: the variance of the hyperbolic secant distribution \(\mbox{Var}[X] = \sigma^2\)

◆ inverseF()

double inverseF ( double u )

Returns the inverse distribution function \(F^{-1}(u)\), defined in ( inverseF ).

Parameters

u	value in the interval \((0,1)\) for which the inverse distribution function is evaluated

Returns: the inverse distribution function evaluated at u

Implements Distribution.

The documentation for this class was generated from the following file:

HyperbolicSecantDist.java

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ barF()

◆ cdf()

◆ getInstanceFromMLE()

◆ getMean()

◆ getMLE()

◆ getParams()

◆ getStandardDeviation()

◆ getVariance()

◆ inverseF()