This class implements a random variate generator for the geometric distribution. More...

Inheritance diagram for umontreal.ssj.randvar.GeometricGen:

Public Member Functions
	GeometricGen (RandomStream s, double p)
	Creates a geometric random variate generator with parameter \(p\), using stream s.
	GeometricGen (RandomStream s, GeometricDist dist)
	Creates a new generator for the distribution dist, using stream s.
int	nextInt ()
	Generates a random number (an integer) from the discrete distribution contained in this object.
double	getP ()
	Returns the parameter \(p\) of 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 p)
	Generates a geometric random variate with parameter \(p = \) p, using stream s, by inversion.

Protected Member Functions
void	setParams (double p)
	Sets the parameter \(n\) and \(p\) of this object.

Detailed Description

This class implements a random variate generator for the geometric distribution.

Its has parameter \(p\) and mass function

\[ p(x) = p(1-p)^x \mbox{ for } x=0,1,2,…, \tag{fgeom} \]

where \(0\le p\le1\). Random variates are generated by calling inversion on the distribution object.

Definition at line 42 of file GeometricGen.java.

Constructor & Destructor Documentation

◆ GeometricGen() [1/2]

umontreal.ssj.randvar.GeometricGen.GeometricGen	(	RandomStream	s,
		double	p )

Creates a geometric random variate generator with parameter \(p\), using stream s.

Definition at line 49 of file GeometricGen.java.

◆ GeometricGen() [2/2]

umontreal.ssj.randvar.GeometricGen.GeometricGen	(	RandomStream	s,
		GeometricDist	dist )

Creates a new generator for the distribution dist, using stream s.

Definition at line 57 of file GeometricGen.java.

Member Function Documentation

◆ getP()

double umontreal.ssj.randvar.GeometricGen.getP ( )

Returns the parameter \(p\) of this object.

Definition at line 78 of file GeometricGen.java.

◆ nextInt() [1/2]

int umontreal.ssj.randvar.GeometricGen.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 63 of file GeometricGen.java.

◆ nextInt() [2/2]

int umontreal.ssj.randvar.GeometricGen.nextInt	(	RandomStream	s,
		double	p )

static

Generates a geometric random variate with parameter \(p = \) p, using stream s, by inversion.

Definition at line 71 of file GeometricGen.java.

◆ setParams()

void umontreal.ssj.randvar.GeometricGen.setParams ( double p )

protected

Sets the parameter \(n\) and \(p\) of this object.

Definition at line 85 of file GeometricGen.java.

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

src/main/java/umontreal/ssj/randvar/GeometricGen.java

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Static Public Member Functions

Protected Member Functions