SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members

This class implements random variate generators for the Cauchy distribution. More...

Inheritance diagram for CauchyGen:
[legend]
Collaboration diagram for CauchyGen:
[legend]

Public Member Functions

 CauchyGen (RandomStream s, double alpha, double beta)
 Creates a Cauchy random variate generator with parameters \(\alpha=\) alpha and \(\beta\) = beta, using stream s.
 
 CauchyGen (RandomStream s)
 Creates a Cauchy random variate generator with parameters \(\alpha=0 \) and \(\beta= 1\), using stream s.
 
 CauchyGen (RandomStream s, CauchyDist dist)
 Create a new generator for the distribution dist, using stream s.
 
double getAlpha ()
 Returns the parameter \(\alpha\) of this object.
 
double getBeta ()
 Returns the parameter \(\beta\) 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 alpha, double beta)
 Generates a new variate from the Cauchy distribution with parameters \(\alpha= \) alpha and \(\beta= \) beta, using stream s.
 

Protected Member Functions

void setParams (double alpha, double beta)
 

Protected Attributes

double alpha
 
double beta
 
- Protected Attributes inherited from RandomVariateGen
RandomStream stream
 
Distribution dist
 

Detailed Description

This class implements random variate generators for the Cauchy distribution.

The density is (see, e.g., [99]  p. 299):

\[ f (x) = \frac{\beta}{\pi[(x-\alpha)^2 + \beta^2]}, \qquad\mbox{for } -\infty< x < \infty, \tag{fcauchy} \]

where \(\beta> 0\).

The (non-static) nextDouble method simply calls inverseF on the distribution.


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