SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | Protected Attributes | List of all members
RandomMultivariateGen Class Referenceabstract

This class is the multivariate counterpart of umontreal.ssj.randvar.RandomVariateGen. More...

Inheritance diagram for RandomMultivariateGen:
[legend]
Collaboration diagram for RandomMultivariateGen:
[legend]

Public Member Functions

abstract void nextPoint (double[] p)
 Generates a random point \(p\) using the the stream contained in this object.
 
void nextArrayOfPoints (double[][] v, int start, int n)
 Generates \(n\) random points. More...
 
int getDimension ()
 Returns the dimension of this multivariate generator (the dimension of the random points).
 
RandomStream getStream ()
 Returns the umontreal.ssj.rng.RandomStream used by this object. More...
 
void setStream (RandomStream stream)
 Sets the umontreal.ssj.rng.RandomStream used by this object to stream.
 

Protected Attributes

int dimension
 
RandomStream stream
 
RandomVariateGen gen1
 

Detailed Description

This class is the multivariate counterpart of umontreal.ssj.randvar.RandomVariateGen.

It is the base class for general random variate generators over the \(d\)-dimensional real space \(\mathbb{R}^d\). It specifies the signature of the nextPoint method, which is normally called to generate a random vector from a given distribution. Contrary to univariate distributions and generators, here the inversion method is not well defined, so we cannot construct a multivariate generator simply by passing a multivariate distribution and a stream; we must specify a generating method as well. For this reason, this class is abstract. Generators can be constructed only by invoking the constructor of a subclass. This is an important difference with umontreal.ssj.randvar.RandomVariateGen.

Member Function Documentation

◆ getStream()

RandomStream getStream ( )

Returns the umontreal.ssj.rng.RandomStream used by this object.

Returns
the stream associated to this object

◆ nextArrayOfPoints()

void nextArrayOfPoints ( double  v[][],
int  start,
int  n 
)

Generates \(n\) random points.

These points are stored in the array v, starting at index start. Thus v[start][i] contains coordinate \(i\) of the first generated point. By default, this method calls nextPoint \(n\) times, but one can override it in subclasses for better efficiency. The array argument v[][d] must have \(d\) elements reserved for each generated point before calling this method.

Parameters
varray in which the variates will be stored
startstarting index, in v, of the new variates
nnumber of variates to generate

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