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

Implements Pascal random variate generators, which is a special case of the negative binomial generator with parameter \(\gamma\) equal to a positive integer. More...

Inheritance diagram for umontreal.ssj.randvar.PascalGen:
umontreal.ssj.randvar.RandomVariateGenInt umontreal.ssj.randvar.RandomVariateGen umontreal.ssj.randvar.PascalConvolutionGen

Public Member Functions

 PascalGen (RandomStream s, int n, double p)
 Creates a Pascal random variate generator with parameters \(n\) and \(p\), using stream s.
 PascalGen (RandomStream s, PascalDist dist)
 Creates a new generator for the distribution dist, using stream s.
int getN ()
 Returns the parameter \(n\) of 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.
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, int n, double p)
 Generates a new variate from the Pascal distribution, with parameters \(n = \) n and \(p = \) p, using stream s.

Protected Member Functions

void setParams (int n, double p)
 Sets the parameter \(n\) and \(p\) of this object.

Detailed Description

Implements Pascal random variate generators, which is a special case of the negative binomial generator with parameter \(\gamma\) equal to a positive integer.

See NegativeBinomialGen for a description.

Definition at line 39 of file PascalGen.java.

Constructor & Destructor Documentation

◆ PascalGen() [1/2]

umontreal.ssj.randvar.PascalGen.PascalGen ( RandomStream s,
int n,
double p )

Creates a Pascal random variate generator with parameters \(n\) and \(p\), using stream s.

Definition at line 47 of file PascalGen.java.

◆ PascalGen() [2/2]

umontreal.ssj.randvar.PascalGen.PascalGen ( RandomStream s,
PascalDist dist )

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

Definition at line 55 of file PascalGen.java.

Member Function Documentation

◆ getN()

int umontreal.ssj.randvar.PascalGen.getN ( )

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

Definition at line 72 of file PascalGen.java.

◆ getP()

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

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

Definition at line 79 of file PascalGen.java.

◆ nextInt()

int umontreal.ssj.randvar.PascalGen.nextInt ( RandomStream s,
int n,
double p )
static

Generates a new variate from the Pascal distribution, with parameters \(n = \) n and \(p = \) p, using stream s.

Reimplemented in umontreal.ssj.randvar.PascalConvolutionGen.

Definition at line 65 of file PascalGen.java.

◆ setParams()

void umontreal.ssj.randvar.PascalGen.setParams ( int n,
double p )
protected

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

Definition at line 86 of file PascalGen.java.


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