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

This class implements random variate generators having the Poisson distribution. More...

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

Public Member Functions

 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.
int nextInt ()
 Generates a random number (an integer) from the discrete distribution contained in this object.
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.

Protected Member Functions

void setParams (double lam)
 Sets the parameter \(\lambda= \) lam of this object.

Detailed Description

This class implements random variate generators having the Poisson distribution.

Its mass function is

\[ p(x) = \frac{e^{-\lambda} \lambda^x}{x!} \qquad\mbox{for } x=0,1,…, \tag{fmass-Poisson} \]

where \(\lambda> 0\) is a real valued parameter equal to the mean.

No local copy of the parameter \(\lambda= \) lambda is maintained in this class. The (non-static) nextInt method simply calls inverseF on the distribution.

Definition at line 46 of file PoissonGen.java.

Constructor & Destructor Documentation

◆ PoissonGen() [1/2]

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

Creates a Poisson random variate generator with parameter.

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

Definition at line 54 of file PoissonGen.java.

◆ PoissonGen() [2/2]

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

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

Definition at line 63 of file PoissonGen.java.

Member Function Documentation

◆ getLambda()

double umontreal.ssj.randvar.PoissonGen.getLambda ( )

Returns the \(\lambda\) associated with this object.

Definition at line 80 of file PoissonGen.java.

◆ nextInt()

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

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

Reimplemented in umontreal.ssj.randvar.PoissonTIACGen.

Definition at line 73 of file PoissonGen.java.

◆ setParams()

void umontreal.ssj.randvar.PoissonGen.setParams ( double lam)
protected

Sets the parameter \(\lambda= \) lam of this object.

Definition at line 87 of file PoissonGen.java.


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