Collaboration diagram for CopulaConfig.StudentTCopulaConfigPy:

Public Member Functions
None	__post_init__ (self)

Any	to_cpp (self)

"StudentTCopulaConfigPy"	from_cpp (cls, Any cpp)

Public Attributes
	nu

Static Public Attributes
MatrixLike	R

int	nu = 4

Detailed Description

Configuration for a Student-t copula.

Args:
    R: Correlation matrix of the latent Student-t vector.
    nu: Degrees of freedom. Smaller values increase tail dependence. The C++
        implementation requires a physically meaningful positive value; in
        practice values such as ``4`` or larger are common starting points.

Raises:
    ValueError: If ``nu`` is not strictly positive.

Examples:
    >>> cfg = StudentTCopulaConfigPy(R=[[1.0, 0.2], [0.2, 1.0]], nu=5)
    >>> cfg.nu
    5

Definition at line 106 of file CopulaConfig.py.

Member Function Documentation

◆ __post_init__()

None CopulaConfig.StudentTCopulaConfigPy.__post_init__ ( self )

Validate the number of degrees of freedom.

Definition at line 127 of file CopulaConfig.py.

◆ from_cpp()

"StudentTCopulaConfigPy" CopulaConfig.StudentTCopulaConfigPy.from_cpp	(		cls,
		Any	cpp
	)

Create a Python config from a bound C++ Student-t config.

Args:
    cpp: Bound C++ ``StudentTCopulaConfig`` instance.

Returns:
    The corresponding Python wrapper.

Definition at line 145 of file CopulaConfig.py.

◆ to_cpp()

Any CopulaConfig.StudentTCopulaConfigPy.to_cpp ( self )

Build the bound C++ ``StudentTCopulaConfig`` object.

Returns:
    A C++ configuration object containing ``R`` and ``nu``.

Definition at line 132 of file CopulaConfig.py.

Member Data Documentation

◆ nu [1/2]

int CopulaConfig.StudentTCopulaConfigPy.nu = 4

static

Definition at line 125 of file CopulaConfig.py.

◆ nu [2/2]

CopulaConfig.StudentTCopulaConfigPy.nu

Definition at line 129 of file CopulaConfig.py.

◆ R

MatrixLike CopulaConfig.StudentTCopulaConfigPy.R

static

Definition at line 124 of file CopulaConfig.py.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Statistic/CopulaConfig.py

Public Member Functions

Public Attributes

Static Public Attributes