This class implements random variate generators for the hyperbolic secant distribution with location parameter \(\mu\) and scale parameter \(\sigma\). More...
Inheritance diagram for HyperbolicSecantGen:
Collaboration diagram for HyperbolicSecantGen:
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 RandomVariateGen | |
| RandomVariateGen (RandomStream s, Distribution dist) | |
Creates a new random variate generator from the distribution dist, using stream s. More... | |
| double | nextDouble () |
| Generates a random number from the continuous distribution contained in this object. More... | |
| void | nextArrayOfDouble (double[] v, int start, int n) |
Generates n random numbers from the continuous distribution contained in this object. More... | |
| 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. More... | |
| RandomStream | getStream () |
| Returns the umontreal.ssj.rng.RandomStream used by this generator. More... | |
| 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. More... | |
| 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. | |
Protected Attributes | |
| double | mu |
| double | sigma |
| Protected Attributes inherited from RandomVariateGen | |
| RandomStream | stream |
| Distribution | dist |
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} \]
The documentation for this class was generated from the following file:
- HyperbolicSecantGen.java
