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

This class implements random variate generators for the noncentral chi square distribution with \(\nu> 0\) degrees of freedom and noncentrality parameter \(\lambda> 0\). More...

Inheritance diagram for umontreal.ssj.randvar.ChiSquareNoncentralGen:
umontreal.ssj.randvar.RandomVariateGen umontreal.ssj.randvar.ChiSquareNoncentralGamGen umontreal.ssj.randvar.ChiSquareNoncentralPoisGen

Public Member Functions

 ChiSquareNoncentralGen (RandomStream s, double nu, double lambda)
 Creates a noncentral chi square random variate generator with nu.
 ChiSquareNoncentralGen (RandomStream s, ChiSquareNoncentralDist dist)
 Create a new generator for the distribution dist and stream s.
double getNu ()
 Returns the value of \(\nu\) of this object.
double getLambda ()
 Returns the value of \(\lambda\) for 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 nu, double lambda)
 Generates a new variate from the noncentral chi square distribution with nu = \(\nu\) degrees of freedom and noncentrality parameter lambda \(=\lambda\), using stream s.

Protected Member Functions

void setParams (double nu, double lambda)
 Sets the parameters \(\nu=\) nu and \(\lambda= \) lambda of this object.

Detailed Description

This class implements random variate generators for the noncentral chi square distribution with \(\nu> 0\) degrees of freedom and noncentrality parameter \(\lambda> 0\).

See the definition in

umontreal.ssj.probdist.ChiSquareNoncentralDist.

 <div class="SSJ-bigskip"></div>

Definition at line 41 of file ChiSquareNoncentralGen.java.

Constructor & Destructor Documentation

◆ ChiSquareNoncentralGen() [1/2]

umontreal.ssj.randvar.ChiSquareNoncentralGen.ChiSquareNoncentralGen ( RandomStream s,
double nu,
double lambda )

Creates a noncentral chi square random variate generator with nu.

\(=\nu>0\) degrees of freedom and noncentrality parameter lambda \(= \lambda>0\), using stream s.

Definition at line 51 of file ChiSquareNoncentralGen.java.

◆ ChiSquareNoncentralGen() [2/2]

umontreal.ssj.randvar.ChiSquareNoncentralGen.ChiSquareNoncentralGen ( RandomStream s,
ChiSquareNoncentralDist dist )

Create a new generator for the distribution dist and stream s.

Definition at line 59 of file ChiSquareNoncentralGen.java.

Member Function Documentation

◆ getLambda()

double umontreal.ssj.randvar.ChiSquareNoncentralGen.getLambda ( )

Returns the value of \(\lambda\) for this object.

Definition at line 84 of file ChiSquareNoncentralGen.java.

◆ getNu()

double umontreal.ssj.randvar.ChiSquareNoncentralGen.getNu ( )

Returns the value of \(\nu\) of this object.

Definition at line 77 of file ChiSquareNoncentralGen.java.

◆ nextDouble()

double umontreal.ssj.randvar.ChiSquareNoncentralGen.nextDouble ( RandomStream s,
double nu,
double lambda )
static

Generates a new variate from the noncentral chi square distribution with nu = \(\nu\) degrees of freedom and noncentrality parameter lambda \(=\lambda\), using stream s.

Reimplemented in umontreal.ssj.randvar.ChiSquareNoncentralGamGen, and umontreal.ssj.randvar.ChiSquareNoncentralPoisGen.

Definition at line 70 of file ChiSquareNoncentralGen.java.

◆ setParams()

void umontreal.ssj.randvar.ChiSquareNoncentralGen.setParams ( double nu,
double lambda )
protected

Sets the parameters \(\nu=\) nu and \(\lambda= \) lambda of this object.

Definition at line 92 of file ChiSquareNoncentralGen.java.


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