This class implements random variate generators for the Nakagami distribution. More...

Inheritance diagram for NakagamiGen:

Collaboration diagram for NakagamiGen:

Public Member Functions
	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`.

	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. More...

double	getLambda ()
	Returns the scale parameter \(\lambda\) of this object. More...

double	getC ()
	Returns the shape parameter \(c\) of this object. More...

Public Member Functions inherited from RandomVariateGen
	RandomVariateGen (RandomStream s, Distribution dist)
	Creates a new random variate generator from the distribution `dist`, using stream `s`. More...

double	nextDouble ()
	Generates a random number from the continuous distribution contained in this object. More...

void	nextArrayOfDouble (double[] v, int start, int n)
	Generates `n` random numbers from the continuous distribution contained in this object. More...

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`. More...

RandomStream	getStream ()
	Returns the umontreal.ssj.rng.RandomStream used by this generator. More...

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. More...

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 \(a=\) `a`, \(\lambda=\) `lambda` and \(c =\) `c`, using stream `s`. More...

Protected Member Functions
void	setParams (double a, double lambda, double c)

Protected Attributes
double	a

double	lambda

double	c

Protected Attributes inherited from RandomVariateGen
RandomStream	stream

Distribution	dist

Detailed Description

This class implements random variate generators for the Nakagami distribution.

See the definition in umontreal.ssj.probdist.NakagamiDist of package probdist.

Member Function Documentation

◆ getA()

double getA ( )

Returns the location parameter \(a\) of this object.

Returns: the location parameter mu

◆ getC()

double getC ( )

Returns the shape parameter \(c\) of this object.

Returns: the shape parameter mu

◆ getLambda()

double getLambda ( )

Returns the scale parameter \(\lambda\) of this object.

Returns: the scale parameter mu

◆ nextDouble()

static double nextDouble	(	RandomStream	s,
		double	a,
		double	lambda,
		double	c
	)

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

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

NakagamiGen.java

Public Member Functions

Static Public Member Functions