This class implements random variate generators for the Nakagami distribution. More...
Public Member Functions | |
| NakagamiGen (RandomStream s, double a, double lambda, double c) | |
| Creates a new Nakagami generator with parameters \(a=\) a,. | |
| NakagamiGen (RandomStream s, NakagamiDist dist) | |
| Creates a new generator for the distribution dist, using stream s. | |
| double | getA () |
| Returns the location parameter \(a\) of this object. | |
| double | getLambda () |
| Returns the scale parameter \(\lambda\) of this object. | |
| double | getC () |
| Returns the shape parameter \(c\) of this object. | |
| 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. | |
| Distribution | getDistribution () |
| Returns the umontreal.ssj.probdist.Distribution used by this generator. | |
| String | toString () |
| Returns a String containing information about the current generator. | |
Static Public Member Functions | |
| static double | nextDouble (RandomStream s, double a, double lambda, double c) |
| Generates a variate from the Nakagami distribution with parameters. | |
Detailed Description
This class implements random variate generators for the Nakagami distribution.
See the definition in
umontreal.ssj.probdist.NakagamiDist of package probdist.
<div class="SSJ-bigskip"></div>
Definition at line 40 of file NakagamiGen.java.
Constructor & Destructor Documentation
◆ NakagamiGen() [1/2]
| umontreal.ssj.randvar.NakagamiGen.NakagamiGen | ( | RandomStream | s, |
| double | a, | ||
| double | lambda, | ||
| double | c ) |
Creates a new Nakagami generator with parameters \(a=\) a,.
\(\lambda=\) lambda and \(c =\) c, using stream s.
Definition at line 51 of file NakagamiGen.java.
◆ NakagamiGen() [2/2]
| umontreal.ssj.randvar.NakagamiGen.NakagamiGen | ( | RandomStream | s, |
| NakagamiDist | dist ) |
Creates a new generator for the distribution dist, using stream s.
Definition at line 59 of file NakagamiGen.java.
Member Function Documentation
◆ getA()
| double umontreal.ssj.randvar.NakagamiGen.getA | ( | ) |
Returns the location parameter \(a\) of this object.
- Returns
- the location parameter mu
Definition at line 84 of file NakagamiGen.java.
◆ getC()
| double umontreal.ssj.randvar.NakagamiGen.getC | ( | ) |
Returns the shape parameter \(c\) of this object.
- Returns
- the shape parameter mu
Definition at line 102 of file NakagamiGen.java.
◆ getLambda()
| double umontreal.ssj.randvar.NakagamiGen.getLambda | ( | ) |
Returns the scale parameter \(\lambda\) of this object.
- Returns
- the scale parameter mu
Definition at line 93 of file NakagamiGen.java.
◆ nextDouble()
|
static |
Generates a variate from the Nakagami distribution with parameters.
\(a=\) a, \(\lambda=\) lambda and \(c =\) c, using stream s.
- Parameters
-
s the random stream a the location parameter lambda the scale parameter c the shape parameter
- Returns
- Generates a variate from the Nakagami distribution
Definition at line 75 of file NakagamiGen.java.
The documentation for this class was generated from the following file:
- src/main/java/umontreal/ssj/randvar/NakagamiGen.java
