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

Same as GammaProcessPCABridge, but uses the fast inversion method for the symmetrical beta distribution, proposed by L’Ecuyer and Simard. More...

Inheritance diagram for umontreal.ssj.stochprocess.GammaProcessPCASymmetricalBridge:
umontreal.ssj.stochprocess.GammaProcessPCABridge umontreal.ssj.stochprocess.GammaProcessPCA umontreal.ssj.stochprocess.GammaProcess umontreal.ssj.stochprocess.StochasticProcess

Public Member Functions

 GammaProcessPCASymmetricalBridge (double s0, double mu, double nu, RandomStream stream)
 Constructs a new GammaProcessPCASymmetricalBridge with parameters.
double[] generatePath (double[] uniform01)
 Generates, returns and saves the path \( \{X(t_0), X(t_1), …, X(t_d)\}\).
double[] generatePath ()
 Generates, returns and saves the path \(\{X(t_0), X(t_1), …, X(t_d)\}\).
Public Member Functions inherited from umontreal.ssj.stochprocess.GammaProcessPCABridge
 GammaProcessPCABridge (double s0, double mu, double nu, RandomStream stream)
 Constructs a new GammaProcessPCABridge with parameters \(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\).
void setParams (double s0, double mu, double nu)
 Sets the parameters s0, \(\mu\) and \(\nu\) to new values, and sets the variance parameters of the BrownianMotionPCA to \(\nu\).
void setObservationTimes (double[] t, int d)
 Sets the observation times of the GammaProcessPCA and the.
BrownianMotionPCA getBMPCA ()
 Returns the inner BrownianMotionPCA.
Public Member Functions inherited from umontreal.ssj.stochprocess.GammaProcessPCA
 GammaProcessPCA (double s0, double mu, double nu, RandomStream stream)
 Constructs a new GammaProcessPCA with parameters \(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\).
 GammaProcessPCA (double s0, double mu, double nu, GammaGen Ggen)
 Constructs a new GammaProcessPCA with parameters \(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\).
double nextObservation ()
 This method is not implemented in this class since the path cannot be generated sequentially.
double nextObservation (double nextT)
 This method is not implemented in this class since the path cannot be generated sequentially.
void setStream (RandomStream stream)
 Resets the umontreal.ssj.rng.RandomStream of the gamma generator and the umontreal.ssj.rng.RandomStream of the inner.
Public Member Functions inherited from umontreal.ssj.stochprocess.GammaProcess
 GammaProcess (double s0, double mu, double nu, RandomStream stream)
 Constructs a new GammaProcess with parameters \(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\).
 GammaProcess (double s0, double mu, double nu, GammaGen Ggen)
 Constructs a new GammaProcess with parameters \(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\).
double getMu ()
 Returns the value of the parameter \(\mu\).
double getNu ()
 Returns the value of the parameter \(\nu\).
RandomStream getStream ()
 Returns the umontreal.ssj.rng.RandomStream stream.
Public Member Functions inherited from umontreal.ssj.stochprocess.StochasticProcess
void setObservationTimes (double delta, int d)
 Sets equidistant observation times at \(t_j = j\delta\), for.
double[] getObservationTimes ()
 Returns a reference to the array that contains the observation times.
int getNumObservationTimes ()
 Returns the number \(d\) of observation times, excluding the time \(t_0\).
double[] generatePath (RandomStream stream)
 Same as generatePath(), but first resets the stream to stream.
double[] getPath ()
 Returns a reference to the last generated sample path \(\{X(t_0), ... , X(t_d)\}\).
void getSubpath (double[] subpath, int[] pathIndices)
 Returns in subpath the values of the process at a subset of the observation times, specified as the times \(t_j\) whose indices.
double getObservation (int j)
 Returns \(X(t_j)\) from the current sample path.
void resetStartProcess ()
 Resets the observation counter to its initial value \(j=0\), so that the current observation \(X(t_j)\) becomes \(X(t_0)\).
boolean hasNextObservation ()
 Returns true if \(j<d\), where \(j\) is the number of observations of the current sample path generated since the last call to resetStartProcess.
int getCurrentObservationIndex ()
 Returns the value of the index \(j\) corresponding to the time.
double getCurrentObservation ()
 Returns the value of the last generated observation \(X(t_j)\).
double getX0 ()
 Returns the initial value \(X(t_0)\) for this process.
void setX0 (double s0)
 Sets the initial value \(X(t_0)\) for this process to s0, and reinitializes.
int[] getArrayMappingCounterToIndex ()
 Returns a reference to an array that maps an integer \(k\) to \(i_k\), the index of the observation \(S(t_{i_k})\) corresponding to the.

Detailed Description

Same as GammaProcessPCABridge, but uses the fast inversion method for the symmetrical beta distribution, proposed by L’Ecuyer and Simard.

[129] , to accelerate the generation of the beta random variables. This class works only in the case where the number of intervals is a power of 2 and all these intervals are of equal size.

Definition at line 41 of file GammaProcessPCASymmetricalBridge.java.

Constructor & Destructor Documentation

◆ GammaProcessPCASymmetricalBridge()

umontreal.ssj.stochprocess.GammaProcessPCASymmetricalBridge.GammaProcessPCASymmetricalBridge ( double s0,
double mu,
double nu,
RandomStream stream )

Constructs a new GammaProcessPCASymmetricalBridge with parameters.

\(\mu= \mathtt{mu}\), \(\nu= \mathtt{nu}\) and initial value \(S(t_0) = \mathtt{s0}\). The umontreal.ssj.rng.RandomStream stream is used in the umontreal.ssj.randvar.GammaGen and in the umontreal.ssj.randvar.BetaSymmetricalGen. These two generators use inversion to generate random numbers. The first uniform random number generated by stream is used for the gamma, and the other \(d-1\) for the beta’s.

Definition at line 54 of file GammaProcessPCASymmetricalBridge.java.

Member Function Documentation

◆ generatePath() [1/2]

double[] umontreal.ssj.stochprocess.GammaProcessPCASymmetricalBridge.generatePath ( )

Generates, returns and saves the path \(\{X(t_0), X(t_1), …, X(t_d)\}\).

The gamma variates \(X\) in ( GammaEqn ) are generated using the

umontreal.ssj.rng.RandomStream stream or the umontreal.ssj.rng.RandomStream included in the umontreal.ssj.randvar.GammaGen Ggen.

Reimplemented from umontreal.ssj.stochprocess.GammaProcessPCABridge.

Definition at line 103 of file GammaProcessPCASymmetricalBridge.java.

◆ generatePath() [2/2]

double[] umontreal.ssj.stochprocess.GammaProcessPCASymmetricalBridge.generatePath ( double[] uniform01)

Generates, returns and saves the path \( \{X(t_0), X(t_1), …, X(t_d)\}\).

This method does not use the

umontreal.ssj.rng.RandomStream stream nor the umontreal.ssj.randvar.GammaGen Ggen. It uses the vector of uniform random numbers \(U(0, 1)\) provided by the user and generates the path by inversion. The vector uniform01 must be of dimension \(d\).

Reimplemented from umontreal.ssj.stochprocess.GammaProcessPCABridge.

Definition at line 58 of file GammaProcessPCASymmetricalBridge.java.


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