SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.probdist.ExponentialDistFromMean Class Reference

Extends the ExponentialDist class with a constructor accepting as argument the mean \(1/\lambda\) instead of the rate \(\lambda\). More...

Inheritance diagram for umontreal.ssj.probdist.ExponentialDistFromMean:
umontreal.ssj.probdist.ExponentialDist umontreal.ssj.probdist.ContinuousDistribution umontreal.ssj.probdist.Distribution

Public Member Functions

 ExponentialDistFromMean (double mean)
 Constructs a new exponential distribution with mean mean.
void setMean (double mean)
 Calls umontreal.ssj.probdist.ExponentialDist.setLambda(double) with argument 1/mean to change the mean of this distribution.
Public Member Functions inherited from umontreal.ssj.probdist.ExponentialDist
 ExponentialDist ()
 Constructs an ExponentialDist object with rate parameter \(\lambda\) = 1.
 ExponentialDist (double lambda)
 Constructs an ExponentialDist object with rate parameter \(\lambda\) = lambda.
double density (double x)
 Returns \(f(x)\), the density evaluated at \(x\).
double cdf (double x)
 Returns the distribution function \(F(x)\).
double barF (double x)
 Returns the complementary distribution function.
double inverseF (double u)
 Returns the inverse distribution function \(x = F^{-1}(u)\).
double getMean ()
 Returns the mean.
double getVariance ()
 Returns the variance.
double getStandardDeviation ()
 Returns the standard deviation.
double getLambda ()
 Returns the value of \(\lambda\) for this object.
void setLambda (double lambda)
 Sets the value of \(\lambda\) for this object.
double[] getParams ()
 Return a table containing the parameters of the current distribution.
String toString ()
 Returns a String containing information about the current distribution.
Public Member Functions inherited from umontreal.ssj.probdist.ContinuousDistribution
double inverseBrent (double a, double b, double u, double tol)
 Computes the inverse distribution function \(x = F^{-1}(u)\), using the Brent-Dekker method.
double inverseBisection (double u)
 Computes and returns the inverse distribution function \(x = F^{-1}(u)\), using bisection.
double getXinf ()
 Returns \(x_a\) such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\).
double getXsup ()
 Returns \(x_b\) such that the probability density is 0 everywhere outside the interval \([x_a, x_b]\).
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]\).
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]\).

Additional Inherited Members

Static Public Member Functions inherited from umontreal.ssj.probdist.ExponentialDist
static double density (double lambda, double x)
 Computes the density function.
static double cdf (double lambda, double x)
 Computes the distribution function.
static double barF (double lambda, double x)
 Computes the complementary distribution function.
static double inverseF (double lambda, double u)
 Computes the inverse distribution function.
static double[] getMLE (double[] x, int n)
 Estimates the rate parameter \(\lambda\) of the exponential distribution using the maximum likelihood method, from the \(n\) observations \(x[i]\), \(i = 0, 1,…, n-1\).
static ExponentialDist getInstanceFromMLE (double[] x, int n)
 Creates a new instance of an exponential distribution with rate parameter.
static double getMean (double lambda)
 Computes and returns the mean, \(E[X] = 1/\lambda\), of the exponential distribution with rate parameter \(\lambda\).
static double getVariance (double lambda)
 Computes and returns the variance, \(\mbox{Var}[X] = 1/\lambda^2\), of the exponential distribution with rate parameter.
static double getStandardDeviation (double lambda)
 Computes and returns the standard deviation of the exponential distribution with rate parameter \(\lambda\).

Detailed Description

Extends the ExponentialDist class with a constructor accepting as argument the mean \(1/\lambda\) instead of the rate \(\lambda\).

Definition at line 35 of file ExponentialDistFromMean.java.

Constructor & Destructor Documentation

◆ ExponentialDistFromMean()

umontreal.ssj.probdist.ExponentialDistFromMean.ExponentialDistFromMean ( double mean)

Constructs a new exponential distribution with mean mean.

Parameters
meanthe required mean.

Definition at line 42 of file ExponentialDistFromMean.java.

Member Function Documentation

◆ setMean()

void umontreal.ssj.probdist.ExponentialDistFromMean.setMean ( double mean)

Calls umontreal.ssj.probdist.ExponentialDist.setLambda(double) with argument 1/mean to change the mean of this distribution.

Parameters
meanthe new mean.

Definition at line 52 of file ExponentialDistFromMean.java.


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