naginterfaces.library.rand.copula_​plackett_​bivar

naginterfaces.library.rand.copula_plackett_bivar(n, theta, sorder, statecomm)[source]

copula_plackett_bivar generates pseudorandom uniform bivariates with joint distribution of a Plackett copula.

For full information please refer to the NAG Library document for g05rg

https://www.nag.com/numeric/nl/nagdoc_27.1/flhtml/g05/g05rgf.html

Parameters
nint

, the number of bivariates to generate.

thetafloat

, the copula parameter.

sorderint

Determines the storage order of variates; the th variate is stored in if , and if , for , for .

statecommdict, RNG communication object, modified in place

RNG communication structure.

This argument must have been initialized by a prior call to init_repeat() or init_nonrepeat().

Returns
xfloat, ndarray, shape

The bivariate uniforms with joint distribution described by , with holding the th value for the th dimension if and the th value for the th dimension if .

Raises
NagValueError
(errno )

On entry, corrupt [‘state’] argument.

(errno )

On entry, invalid : .

Constraint: .

(errno )

On entry, .

Constraint: .

(errno )

On entry, invalid .

Constraint: or .

Notes

Generates pseudorandom uniform bivariates whose joint distribution is the Plackett copula with parameter , given by

with the special cases:

, the Fréchet–Hoeffding lower bound;

, the product copula;

, the Fréchet–Hoeffding upper bound.

The generation method uses conditional sampling.

One of the initialization functions init_repeat() (for a repeatable sequence if computed sequentially) or init_nonrepeat() (for a non-repeatable sequence) must be called prior to the first call to copula_plackett_bivar.

References

Nelsen, R B, 2006, An Introduction to Copulas, (2nd Edition), Springer Series in Statistics