JointDistribution Namespace Reference

Classes
class	JointDistribution
class	JointDistributionFactory

Functions
	_require (value, typ, str name)
	_cpp_marginal_kind (MarginalKind kind)
	_cpp_copula_kind (CopulaKind kind)
	_cpp_marginal_config (MarginalConfig cfg)
	_cpp_copula_config (CopulaConfig cfg)

Detailed Description

Joint probability distributions built from marginals and a copula.

The C++ backend represents a joint law as a set of one-dimensional marginal
distributions plus a copula. This Python module exposes wrappers and factory
helpers to build such distributions from Python configuration objects.

Function Documentation

_cpp_copula_config()

JointDistribution._cpp_copula_config ( CopulaConfig  cfg )

protected

Convert a Python copula configuration to its C++ representation.

Raises:
    TypeError: If the configuration family is not supported.

Definition at line 84 of file JointDistribution.py.

_cpp_copula_kind()

JointDistribution._cpp_copula_kind ( CopulaKind  kind )

protected

Convert a Python copula kind to the C++ enum value.

Definition at line 60 of file JointDistribution.py.

_cpp_marginal_config()

JointDistribution._cpp_marginal_config ( MarginalConfig  cfg )

protected

Convert a Python marginal configuration to its C++ representation.

Raises:
    TypeError: If the configuration family is not supported.

Definition at line 65 of file JointDistribution.py.

_cpp_marginal_kind()

JointDistribution._cpp_marginal_kind ( MarginalKind  kind )

protected

Convert a Python marginal kind to the C++ enum value.

Definition at line 55 of file JointDistribution.py.

_require()

JointDistribution._require (   value,   typ, str  name  )

protected

Validate the type of a user-facing argument.

Args:
    value: Object to validate.
    typ: Expected Python type.
    name: Argument name used in the error message.

Returns:
    The original value.

Raises:
    TypeError: If ``value`` is not an instance of ``typ``.

Definition at line 36 of file JointDistribution.py.