CopulaConfig.GaussianCopulaConfigPy Class Reference

Collaboration diagram for CopulaConfig.GaussianCopulaConfigPy:

Public Member Functions
Any	to_cpp (self)
"GaussianCopulaConfigPy"	from_cpp (cls, Any cpp)

Static Public Attributes
MatrixLike	R

Detailed Description

Configuration for a Gaussian copula.

Args:
    R: Correlation matrix of the latent Gaussian vector. The matrix should
        be square, symmetric and have diagonal entries close to one. The C++
        implementation regularizes/projects it before decomposition.

Examples:
    >>> cfg = GaussianCopulaConfigPy(R=[[1.0, 0.4], [0.4, 1.0]])
    >>> cpp_cfg = cfg.to_cpp()

Definition at line 68 of file CopulaConfig.py.

Member Function Documentation

from_cpp()

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

Create a Python config from a bound C++ config.

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

Returns:
    The corresponding Python wrapper.

Definition at line 93 of file CopulaConfig.py.

to_cpp()

Any CopulaConfig.GaussianCopulaConfigPy.to_cpp

(

self

)

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

Returns:
    A C++ configuration object containing the correlation matrix.

Definition at line 83 of file CopulaConfig.py.

Member Data Documentation

R

MatrixLike CopulaConfig.GaussianCopulaConfigPy.R

static

Definition at line 81 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