This class implements methods for generating random variates from the folded normal distribution with parameters \(\mu\ge0\) and \(\sigma> 0\). More...
Inheritance diagram for FoldedNormalGen:
Collaboration diagram for FoldedNormalGen:
Public Member Functions | |
| FoldedNormalGen (RandomStream s, double mu, double sigma) | |
Creates a new folded normal generator with parameters \(\mu=\) mu and \(\sigma=\) sigma, using stream s. | |
| FoldedNormalGen (RandomStream s, FoldedNormalDist dist) | |
Creates a new generator for the distribution dist, using stream s. | |
| double | getMu () |
| Returns the parameter \(\mu\) of this object. More... | |
| double | getSigma () |
| Returns the parameter \(\sigma\) of this object. More... | |
 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 folded normal distribution with parameters \(\mu= \) mu and \(\sigma= \) sigma, using stream s. More... | |
Protected Member Functions | |
| void | setParams (double mu, double sigma) |
Protected Attributes | |
| double | mu |
| double | sigma |
| Protected Attributes inherited from RandomVariateGen | |
| RandomStream | stream |
| Distribution | dist |
Detailed Description
This class implements methods for generating random variates from the folded normal distribution with parameters \(\mu\ge0\) and \(\sigma> 0\).
\[ f(x) = \phi\left(\frac{x-\mu}{\sigma}\right) + \phi\left(\frac{-x-\mu}{\sigma}\right) \qquad\mbox{for } x \ge0, \tag{fFoldedNormal} \]
where \( \phi\) denotes the density function of a standard normal distribution.
Member Function Documentation
◆ getMu()
| double getMu | ( | ) |
Returns the parameter \(\mu\) of this object.
- Returns
- the parameter mu
◆ getSigma()
| double getSigma | ( | ) |
Returns the parameter \(\sigma\) of this object.
- Returns
- the parameter mu
◆ nextDouble()
|
static |
Generates a variate from the folded normal distribution with parameters \(\mu= \) mu and \(\sigma= \) sigma, using stream s.
- Parameters
-
s the random stream mu the parameter mu sigma the parameter sigma
- Returns
- Generates a variate from the FoldedNormal distribution
The documentation for this class was generated from the following file:
- FoldedNormalGen.java
