MarginalDistribution.DistributionFactoryWrapper Class Reference

Static Public Member Functions
MarginalDistribution	create (MarginalKind kind, MarginalConfig config, Optional[int] seed=None)
GaussianMarginalDist	gaussian (float mu, float sigma, Optional[int] seed=None)
SplitGaussianMarginalDist	split_gaussian (float mu, float sigma_p, float sigma_m, Optional[int] seed=None)
FlatMarginalDist	flat (float a, float b, Optional[int] seed=None)
LikelihoodMarginalDist	likelihood (Sequence[float] values, Sequence[float] weights, Optional[int] seed=None, bool standardize=False)

Detailed Description

Factory helpers for marginal distributions.

Definition at line 173 of file MarginalDistribution.py.

Member Function Documentation

create()

MarginalDistribution MarginalDistribution.DistributionFactoryWrapper.create ( MarginalKind  kind, MarginalConfig  config, Optional[int]   seed = None  )

static

Create a marginal distribution from a kind and configuration.

Args:
    kind: Marginal family to instantiate.
    config: Configuration object compatible with ``kind``.
    seed: Optional RNG seed.

Returns:
    A Python wrapper around the bound C++ marginal.

Definition at line 177 of file MarginalDistribution.py.

flat()

FlatMarginalDist MarginalDistribution.DistributionFactoryWrapper.flat ( float  a, float  b, Optional[int]   seed = None  )

static

Create a uniform marginal over ``[a, b]``.

Definition at line 239 of file MarginalDistribution.py.

gaussian()

GaussianMarginalDist MarginalDistribution.DistributionFactoryWrapper.gaussian ( float  mu, float  sigma, Optional[int]   seed = None  )

static

Create a Gaussian marginal.

Args:
    mu: Central value.
    sigma: Standard deviation.
    seed: Optional RNG seed.

Returns:
    A ``GaussianMarginalDist`` wrapper.

Definition at line 196 of file MarginalDistribution.py.

likelihood()

LikelihoodMarginalDist MarginalDistribution.DistributionFactoryWrapper.likelihood ( Sequence[float]  values, Sequence[float]  weights, Optional[int]   seed = None, bool   standardize = False  )

static

Create an empirical likelihood marginal.

Args:
    values: Empirical support values.
    weights: Weights associated with each support value.
    seed: Optional RNG seed.
    standardize: If true, use the backend constructor that standardizes
        the likelihood marginal.

Returns:
    A ``LikelihoodMarginalDist`` wrapper.

Raises:
    ValueError: If ``values`` and ``weights`` have different lengths.

Definition at line 249 of file MarginalDistribution.py.

split_gaussian()

SplitGaussianMarginalDist MarginalDistribution.DistributionFactoryWrapper.split_gaussian ( float  mu, float  sigma_p, float  sigma_m, Optional[int]   seed = None  )

static

Create an asymmetric split-Gaussian marginal.

Args:
    mu: Central value or mode.
    sigma_p: Right-side standard deviation.
    sigma_m: Left-side standard deviation.
    seed: Optional RNG seed.

Returns:
    A ``SplitGaussianMarginalDist`` wrapper.

Definition at line 215 of file MarginalDistribution.py.

---

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

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Statistic/MarginalDistribution.py