Public Member Functions
None	__init__ (self, cpp_obj)

"JointDistribution"	from_cpp (cls, cpp_obj)

Union[List[float], List[List[float]]]	sample (self, Optional[int] n=None)

float	logpdf (self, Sequence[float] x)

int	dim (self)

int	ndim (self)

str	__repr__ (self)

Protected Member Functions
	_to_cpp (self)

Protected Attributes
	_cpp_obj

Detailed Description

Python wrapper around a C++ joint distribution.

A joint distribution combines marginal distributions with a dependence
structure encoded by a copula. It is used by the statistic layer for nuisance
parameters and experimental observables.

Args:
    cpp_obj: Bound C++ ``JointDistribution`` instance.

Definition at line 95 of file JointDistribution.py.

Constructor & Destructor Documentation

◆ init()

None JointDistribution.JointDistribution.__init__	(	self,
		cpp_obj
	)

Store the bound C++ joint distribution object.

Definition at line 108 of file JointDistribution.py.

Member Function Documentation

◆ repr()

str JointDistribution.JointDistribution.__repr__ ( self )

Return a compact representation useful in notebooks and logs.

Definition at line 169 of file JointDistribution.py.

◆ _to_cpp()

JointDistribution.JointDistribution._to_cpp ( self )

protected

Return the underlying C++ object for internal binding calls.

Definition at line 124 of file JointDistribution.py.

◆ dim()

int JointDistribution.JointDistribution.dim ( self )

Return the distribution dimension.

Definition at line 160 of file JointDistribution.py.

◆ from_cpp()

"JointDistribution" JointDistribution.JointDistribution.from_cpp	(	cls,
		cpp_obj
	)

Wrap a bound C++ joint distribution.

Args:
    cpp_obj: Bound C++ ``JointDistribution`` instance.

Returns:
    A Python wrapper retaining the C++ object.

Definition at line 113 of file JointDistribution.py.

◆ logpdf()

float JointDistribution.JointDistribution.logpdf	(		self,
		Sequence[float]	x
	)

Evaluate the joint log-density at ``x``.

Args:
    x: Point in physical variable space. Its length must match the joint
        distribution dimension.

Returns:
    The scalar log-density ``log f(x)``.

Definition at line 148 of file JointDistribution.py.

◆ ndim()

int JointDistribution.JointDistribution.ndim ( self )

Alias for :meth:`dim`, following NumPy naming conventions.

Definition at line 165 of file JointDistribution.py.

◆ sample()

Union[List[float], List[List[float]]] JointDistribution.JointDistribution.sample	(		self,
		Optional[int]	n = `None`
	)

Draw one or more samples from the joint distribution.

Args:
    n: Optional number of samples. When omitted, a single sample vector is
        returned.

Returns:
    A single sample ``list[float]`` when ``n`` is ``None``; otherwise a
    list of sample vectors with shape ``n x dim``.

Raises:
    ValueError: If ``n`` is negative.

Definition at line 128 of file JointDistribution.py.

Member Data Documentation

◆ _cpp_obj

JointDistribution.JointDistribution._cpp_obj

protected

Definition at line 110 of file JointDistribution.py.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes