Inheritance diagram for MarginalDistribution.MarginalDistribution:

[legend]

Public Member Functions
None	__init__ (self, cpp_obj)

"MarginalDistribution"	from_cpp (cls, cpp_obj)

List[float]	rvs (self, int n)

float	logpdf (self, float x)

float	cdf (self, float x)

float	ppf (self, float p)

float	mean (self)

float	std (self)

Protected Member Functions
	_to_cpp (self)

Protected Attributes
	_cpp_obj

Detailed Description

Base wrapper around a bound C++ marginal distribution.

Args:
    cpp_obj: Bound C++ marginal distribution object.

Definition at line 63 of file MarginalDistribution.py.

Constructor & Destructor Documentation

◆ init()

None MarginalDistribution.MarginalDistribution.__init__	(	self,
		cpp_obj
	)

Store the bound C++ marginal distribution object.

Definition at line 70 of file MarginalDistribution.py.

Member Function Documentation

◆ _to_cpp()

MarginalDistribution.MarginalDistribution._to_cpp ( self )

protected

Return the underlying C++ object for internal calls.

Definition at line 95 of file MarginalDistribution.py.

◆ cdf()

float MarginalDistribution.MarginalDistribution.cdf	(		self,
		float	x
	)

Evaluate the cumulative distribution function at ``x``.

Definition at line 119 of file MarginalDistribution.py.

◆ from_cpp()

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

Wrap a C++ marginal with the most specific Python subclass.

Args:
    cpp_obj: Bound C++ marginal distribution object.

Returns:
    A subclass wrapper when the C++ type is recognized, otherwise a
    generic ``MarginalDistribution``.

Definition at line 75 of file MarginalDistribution.py.

◆ logpdf()

float MarginalDistribution.MarginalDistribution.logpdf	(		self,
		float	x
	)

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

Definition at line 115 of file MarginalDistribution.py.

◆ mean()

float MarginalDistribution.MarginalDistribution.mean ( self )

Return the marginal mean.

Definition at line 140 of file MarginalDistribution.py.

◆ ppf()

float MarginalDistribution.MarginalDistribution.ppf	(		self,
		float	p
	)

Evaluate the quantile function.

Args:
    p: Probability in the closed interval ``[0, 1]``.

Returns:
    The value ``x`` such that ``cdf(x) ~= p``.

Raises:
    ValueError: If ``p`` is outside ``[0, 1]``.

Definition at line 123 of file MarginalDistribution.py.

◆ rvs()

List[float] MarginalDistribution.MarginalDistribution.rvs	(		self,
		int	n
	)

Draw independent random variates from the marginal.

Args:
    n: Number of variates to draw.

Returns:
    A list of ``n`` floats.

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

Definition at line 99 of file MarginalDistribution.py.

◆ std()

float MarginalDistribution.MarginalDistribution.std ( self )

Return the marginal standard deviation.

Definition at line 144 of file MarginalDistribution.py.

Member Data Documentation

◆ _cpp_obj

MarginalDistribution.MarginalDistribution._cpp_obj