This class implements random variate generators for the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma\). More...
Public Member Functions | |
| HyperbolicSecantGen (RandomStream s, double mu, double sigma) | |
| Creates a hyperbolic secant random variate generator with parameters \(\mu=\) mu and \(\sigma=\) sigma, using stream s. | |
| HyperbolicSecantGen (RandomStream s) | |
| Creates a hyperbolic secant random variate generator with parameters \(\mu=0\) and \(\sigma=1\), using stream s. | |
| HyperbolicSecantGen (RandomStream s, HyperbolicSecantDist dist) | |
| Creates a new generator for the distribution dist, using stream s. | |
| double | getMu () |
| Returns the parameter \(\mu\) of this object. | |
| double | getSigma () |
| Returns the parameter \(\sigma\) of this object. | |
| Public Member Functions inherited from umontreal.ssj.randvar.RandomVariateGen | |
| RandomVariateGen (RandomStream s, Distribution dist) | |
| Creates a new random variate generator from the distribution dist, using stream s. | |
| double | nextDouble () |
| Generates a random number from the continuous distribution contained in this object. | |
| void | nextArrayOfDouble (double[] v, int start, int n) |
| Generates n random numbers from the continuous distribution contained in this object. | |
| double[] | nextArrayOfDouble (int n) |
| Generates n random numbers from the continuous distribution contained in this object, and returns them in a new array of size n. | |
| RandomStream | getStream () |
| Returns the umontreal.ssj.rng.RandomStream used by this generator. | |
| void | setStream (RandomStream stream) |
| Sets the umontreal.ssj.rng.RandomStream used by this generator to stream. | |
| Distribution | getDistribution () |
| Returns the umontreal.ssj.probdist.Distribution used by this generator. | |
| String | toString () |
| Returns a String containing information about the current generator. | |
Static Public Member Functions | |
| static double | nextDouble (RandomStream s, double mu, double sigma) |
| Generates a variate from the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma\). | |
Protected Member Functions | |
| void | setParams (double mu, double sigma) |
| Sets the parameters \(\mu\) and \(\sigma\) of this object. | |
Detailed Description
This class implements random variate generators for the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma\).
The density function of this distribution is
\[ f(x) = \frac{1}{2 \sigma} \mbox{ sech}\left(\frac{\pi}{2} \frac{(x - \mu)}{\sigma}\right), \qquad-\infty<x < \infty. \tag{fHyperbolicSecant} \]
Definition at line 42 of file HyperbolicSecantGen.java.
Constructor & Destructor Documentation
◆ HyperbolicSecantGen() [1/3]
| umontreal.ssj.randvar.HyperbolicSecantGen.HyperbolicSecantGen | ( | RandomStream | s, |
| double | mu, | ||
| double | sigma ) |
Creates a hyperbolic secant random variate generator with parameters \(\mu=\) mu and \(\sigma=\) sigma, using stream s.
Definition at line 50 of file HyperbolicSecantGen.java.
◆ HyperbolicSecantGen() [2/3]
| umontreal.ssj.randvar.HyperbolicSecantGen.HyperbolicSecantGen | ( | RandomStream | s | ) |
Creates a hyperbolic secant random variate generator with parameters \(\mu=0\) and \(\sigma=1\), using stream s.
Definition at line 59 of file HyperbolicSecantGen.java.
◆ HyperbolicSecantGen() [3/3]
| umontreal.ssj.randvar.HyperbolicSecantGen.HyperbolicSecantGen | ( | RandomStream | s, |
| HyperbolicSecantDist | dist ) |
Creates a new generator for the distribution dist, using stream s.
Definition at line 66 of file HyperbolicSecantGen.java.
Member Function Documentation
◆ getMu()
| double umontreal.ssj.randvar.HyperbolicSecantGen.getMu | ( | ) |
Returns the parameter \(\mu\) of this object.
Definition at line 83 of file HyperbolicSecantGen.java.
◆ getSigma()
| double umontreal.ssj.randvar.HyperbolicSecantGen.getSigma | ( | ) |
Returns the parameter \(\sigma\) of this object.
Definition at line 90 of file HyperbolicSecantGen.java.
◆ nextDouble()
|
static |
Generates a variate from the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma\).
Definition at line 76 of file HyperbolicSecantGen.java.
◆ setParams()
|
protected |
Sets the parameters \(\mu\) and \(\sigma\) of this object.
Definition at line 97 of file HyperbolicSecantGen.java.
The documentation for this class was generated from the following file:
- src/main/java/umontreal/ssj/randvar/HyperbolicSecantGen.java
