This class implements random variate generators having the negative binomial distribution. More...
Public Member Functions | |
| NegativeBinomialGen (RandomStream s, double gamma, double p) | |
| Creates a negative binomial random variate generator with parameters. | |
| NegativeBinomialGen (RandomStream s, NegativeBinomialDist dist) | |
| Creates a new generator for the distribution dist, using stream s. | |
| double | getGamma () |
| Returns the parameter \(\gamma\) 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, double gamma, double p) |
| Generates a new variate from the negative binomial distribution, with parameters \(\gamma= \) gamma and \(p =
\) p, using stream s. | |
Protected Member Functions | |
| void | setParams (double gamma, double p) |
| Sets the parameter \(\gamma\) and \(p\) of this object. | |
Detailed Description
This class implements random variate generators having the negative binomial distribution.
Its mass function is
\[ p(x) = \frac{\Gamma(\gamma+ x)}{x!\: \Gamma(\gamma)}\: p^{\gamma}(1 - p)^x, \qquad\mbox{for } x = 0, 1, 2, …\tag{fmass-negbin} \]
where \(\Gamma\) is the gamma function, \(\gamma> 0\) and \(0\le p\le1\). No local copy of the parameters \(\gamma\) and \(p\) is maintained in this class. The (non-static) nextInt method simply calls inverseF on the distribution.
Definition at line 46 of file NegativeBinomialGen.java.
Constructor & Destructor Documentation
◆ NegativeBinomialGen() [1/2]
| umontreal.ssj.randvar.NegativeBinomialGen.NegativeBinomialGen | ( | RandomStream | s, |
| double | gamma, | ||
| double | p ) |
Creates a negative binomial random variate generator with parameters.
\(\gamma= \) gamma and \(p\), using stream s.
Definition at line 55 of file NegativeBinomialGen.java.
◆ NegativeBinomialGen() [2/2]
| umontreal.ssj.randvar.NegativeBinomialGen.NegativeBinomialGen | ( | RandomStream | s, |
| NegativeBinomialDist | dist ) |
Creates a new generator for the distribution dist, using stream s.
Definition at line 63 of file NegativeBinomialGen.java.
Member Function Documentation
◆ getGamma()
| double umontreal.ssj.randvar.NegativeBinomialGen.getGamma | ( | ) |
Returns the parameter \(\gamma\) of this object.
Definition at line 82 of file NegativeBinomialGen.java.
◆ getP()
| double umontreal.ssj.randvar.NegativeBinomialGen.getP | ( | ) |
Returns the parameter \(p\) of this object.
Definition at line 89 of file NegativeBinomialGen.java.
◆ nextInt()
|
static |
Generates a new variate from the negative binomial distribution, with parameters \(\gamma= \) gamma and \(p = \) p, using stream s.
Definition at line 75 of file NegativeBinomialGen.java.
◆ setParams()
|
protected |
Sets the parameter \(\gamma\) and \(p\) of this object.
Definition at line 96 of file NegativeBinomialGen.java.
The documentation for this class was generated from the following file:
- src/main/java/umontreal/ssj/randvar/NegativeBinomialGen.java
