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

This class implements random variate generators having the Poisson distribution (see PoissonGen ). More...

Inheritance diagram for umontreal.ssj.randvar.PoissonTIACGen:
umontreal.ssj.randvar.PoissonGen umontreal.ssj.randvar.RandomVariateGenInt umontreal.ssj.randvar.RandomVariateGen

Public Member Functions

 PoissonTIACGen (RandomStream s, double lambda)
 Creates a Poisson random variate generator with parameter.
 PoissonTIACGen (RandomStream s, PoissonDist dist)
 Creates a new random variate generator using the Poisson distribution dist and stream s.
int nextInt ()
 Generates a random number (an integer) from the discrete distribution contained in this object.
Public Member Functions inherited from umontreal.ssj.randvar.PoissonGen
 PoissonGen (RandomStream s, double lambda)
 Creates a Poisson random variate generator with parameter.
 PoissonGen (RandomStream s, PoissonDist dist)
 Creates a new random variate generator using the Poisson distribution dist and stream s.
double getLambda ()
 Returns the \(\lambda\) associated with this object.
Public Member Functions inherited from umontreal.ssj.randvar.RandomVariateGenInt
 RandomVariateGenInt (RandomStream s, DiscreteDistributionInt dist)
 Creates a new random variate generator for the discrete distribution dist, using stream s.
void nextArrayOfInt (int[] v, int start, int n)
 Generates n random numbers from the discrete distribution contained in this object.
int[] nextArrayOfInt (int n)
 Generates n random numbers from the discrete distribution contained in this object, and returns them in a new array of size n.
DiscreteDistributionInt getDistribution ()
 Returns the umontreal.ssj.probdist.DiscreteDistributionInt used by this generator.
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.
String toString ()
 Returns a String containing information about the current generator.

Static Public Member Functions

static int nextInt (RandomStream s, double lambda)
 A static method for generating a random variate from a Poisson distribution with parameter \(\lambda\) = lambda.

Additional Inherited Members

Protected Member Functions inherited from umontreal.ssj.randvar.PoissonGen
void setParams (double lam)
 Sets the parameter \(\lambda= \) lam of this object.

Detailed Description

This class implements random variate generators having the Poisson distribution (see PoissonGen ).

Uses the tabulated inversion combined with the acceptance complement (TIAC) method of

[3] . The implementation is adapted from UNURAN [162] .

  <div class="SSJ-bigskip"></div>

Definition at line 44 of file PoissonTIACGen.java.

Constructor & Destructor Documentation

◆ PoissonTIACGen() [1/2]

umontreal.ssj.randvar.PoissonTIACGen.PoissonTIACGen ( RandomStream s,
double lambda )

Creates a Poisson random variate generator with parameter.

\(\lambda= \) lambda, using stream s.

Definition at line 57 of file PoissonTIACGen.java.

◆ PoissonTIACGen() [2/2]

umontreal.ssj.randvar.PoissonTIACGen.PoissonTIACGen ( RandomStream s,
PoissonDist dist )

Creates a new random variate generator using the Poisson distribution dist and stream s.

Definition at line 66 of file PoissonTIACGen.java.

Member Function Documentation

◆ nextInt() [1/2]

int umontreal.ssj.randvar.PoissonTIACGen.nextInt ( )

Generates a random number (an integer) from the discrete distribution contained in this object.

By default, this method uses inversion by calling the inverseF method of the distribution object. Alternative generating methods are provided in subclasses.

Returns
the generated value

Reimplemented from umontreal.ssj.randvar.RandomVariateGenInt.

Definition at line 71 of file PoissonTIACGen.java.

◆ nextInt() [2/2]

int umontreal.ssj.randvar.PoissonTIACGen.nextInt ( RandomStream s,
double lambda )
static

A static method for generating a random variate from a Poisson distribution with parameter \(\lambda\) = lambda.

Reimplemented from umontreal.ssj.randvar.PoissonGen.

Definition at line 79 of file PoissonTIACGen.java.


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