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

Implements binomial random variate generators using the convolution method. More...

Inheritance diagram for umontreal.ssj.randvar.BinomialConvolutionGen:
umontreal.ssj.randvar.BinomialGen umontreal.ssj.randvar.RandomVariateGenInt umontreal.ssj.randvar.RandomVariateGen

Public Member Functions

 BinomialConvolutionGen (RandomStream s, int n, double p)
 Creates a binomial random variate generator with parameters.
 BinomialConvolutionGen (RandomStream s, BinomialDist dist)
 Creates a random variate generator for the binomial 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.BinomialGen
 BinomialGen (RandomStream s, int n, double p)
 Creates a binomial random variate generator with parameters \(n\) and \(p\), using stream s.
 BinomialGen (RandomStream s, BinomialDist dist)
 Creates a random variate generator for the binomial distribution dist and the random 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.
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 integer from the binomial distribution with parameters.

Additional Inherited Members

Protected Member Functions inherited from umontreal.ssj.randvar.BinomialGen
void setParams (int n, double p)
 Sets the parameter \(n\) and \(p\) of this object.

Detailed Description

Implements binomial random variate generators using the convolution method.

This method generates \(n\) Bernouilli random variates with parameter \(p\) and adds them up. Its advantages are that it requires little computer memory and no setup time. Its disadvantage is that it is very slow for large \(n\). It makes sense only when \(n\) is small.

Definition at line 41 of file BinomialConvolutionGen.java.

Constructor & Destructor Documentation

◆ BinomialConvolutionGen() [1/2]

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

Creates a binomial random variate generator with parameters.

\(n\) and \(p\), using stream s.

Definition at line 48 of file BinomialConvolutionGen.java.

◆ BinomialConvolutionGen() [2/2]

umontreal.ssj.randvar.BinomialConvolutionGen.BinomialConvolutionGen ( RandomStream s,
BinomialDist dist )

Creates a random variate generator for the binomial distribution dist and stream s.

Definition at line 57 of file BinomialConvolutionGen.java.

Member Function Documentation

◆ nextInt() [1/2]

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

◆ nextInt() [2/2]

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

Generates a new integer from the binomial distribution with parameters.

\(n = \) n and \(p = \) p, using the given stream s.

Reimplemented from umontreal.ssj.randvar.BinomialGen.

Definition at line 76 of file BinomialConvolutionGen.java.


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