SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.probdistmulti.norta.NI2b Class Reference

Extends the class NortaInitDisc and implements the algorithm NI2b. More...

Inheritance diagram for umontreal.ssj.probdistmulti.norta.NI2b:
umontreal.ssj.probdistmulti.norta.NortaInitDisc

Public Member Functions

 NI2b (double rX, DiscreteDistributionInt dist1, DiscreteDistributionInt dist2, double tr, int m, double delta)
 Constructor with the target rank correlation rX, the two discrete marginals dist1 and dist2, the parameter for the truncation tr (see the constructor of class NortaInitDisc ), and the specific parameters m and \(\delta=\) delta for the algorithm NI2b, as described above.
double computeCorr ()
 Computes and returns the correlation \(\rho_Z\) using the algorithm NI2b.
Public Member Functions inherited from umontreal.ssj.probdistmulti.norta.NortaInitDisc
 NortaInitDisc (double rX, DiscreteDistributionInt dist1, DiscreteDistributionInt dist2, double tr)
 Constructor with the target rank correlation rX, the two discrete marginals dist1 and dist2 and the parameter for the truncation tr.
void computeParams ()
 Computes the following inputs of each marginal distribution:
double integ (double r)
 Computes the function.
double deriv (double r)
 Computes the derivative of \(g_r\), given by.

Detailed Description

Extends the class NortaInitDisc and implements the algorithm NI2b.

It is a variant of NI2a. It uses the derivative, so it calls the method deriv to compute the function \(g’_r\) given in ( grp_M ) and uses numerical integration with Simpson’s rules as well. But the integration grid is either in the interval \([0,1-\delta]\) or

\([-1+\delta, 0]\), depending on the sign of \(r_X\). Here the number of subintervals of integration is fixed to \(m\) and the algorithm stops at iteration \(k\) if the root is in subinterval \([\rho_{k-1},\rho_k]\), and a quadratic interpolation is used to compute the solution. For this, the method #interpol of class umontreal.ssj.util.Misc (from package util of SSJ [150] ) is used.

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

Definition at line 50 of file NI2b.java.

Constructor & Destructor Documentation

◆ NI2b()

umontreal.ssj.probdistmulti.norta.NI2b.NI2b ( double rX,
DiscreteDistributionInt dist1,
DiscreteDistributionInt dist2,
double tr,
int m,
double delta )

Constructor with the target rank correlation rX, the two discrete marginals dist1 and dist2, the parameter for the truncation tr (see the constructor of class NortaInitDisc ), and the specific parameters m and \(\delta=\) delta for the algorithm NI2b, as described above.

Definition at line 66 of file NI2b.java.

Member Function Documentation

◆ computeCorr()

double umontreal.ssj.probdistmulti.norta.NI2b.computeCorr ( )

Computes and returns the correlation \(\rho_Z\) using the algorithm NI2b.

Reimplemented from umontreal.ssj.probdistmulti.norta.NortaInitDisc.

Definition at line 77 of file NI2b.java.


The documentation for this class was generated from the following file:
  • src/main/java/umontreal/ssj/probdistmulti/norta/NI2b.java