gemseo / uncertainty / distributions

factory module

Module containing a factory to create an instance of Distribution.

class gemseo.uncertainty.distributions.factory.DistributionFactory

Bases: object

Factory to build instances of Distribution.

At initialization, this factory scans the following modules to search for subclasses of this class:

• the modules located in gemseo.uncertainty.distributions and its sub-packages,

• the modules referenced in the GEMSEO_PATH,

• the modules referenced in the PYTHONPATH and starting with gemseo_.

Then, it can check if a class is present or return the list of available classes.

Lastly, it can create an instance of a class.

Examples

>>> from gemseo.uncertainty.distributions.factory import DistributionFactory
>>> factory = DistributionFactory()
>>> factory.is_available("OTNormalDistribution")
True
>>> factory.available_distributions[-3:]
['SPNormalDistribution', 'SPTriangularDistribution', 'SPUniformDistribution']
>>> distribution = factory.create("OTNormalDistribution", "x")
>>> print(distribution)
Normal(mu=0.0, sigma=1.0)

create(distribution_name, variable, **parameters)

Create a marginal probability distribution for a given random variable.

Parameters:

• distribution_name (str) – The name of a class defining a distribution.

• variable (str) – The name of the random variable.

• **parameters (Union[int, Tuple[str, int, float], Mapping[str, Union[str, int, float]], None, float]) – The parameters of the distribution.

Returns:

The marginal probability distribution.

Return type:

Distribution

create_composed_distribution(distributions, copula_name='independent_copula', variable='')

Create a composed probability distribution from marginal ones.

Parameters:

• distributions (Sequence[Distribution]) – The marginal distributions.

• copula_name (str) –

  The name of the copula.

  By default it is set to “independent_copula”.

• variable (str) –

  The name of the variable, if any; otherwise, concatenate the names of the random variables defined by distributions.

  By default it is set to “”.

Returns:

The composed probability distribution.

Return type:

ComposedDistribution

create_marginal_distribution(distribution_name, variable, **parameters)

Create a marginal probability distribution for a given random variable.

Parameters:

• distribution_name (str) – The name of a class defining a distribution.

• variable (str) – The name of the random variable.

• **parameters (Union[int, Tuple[str, int, float], Mapping[str, Union[str, int, float]], None, float]) – The parameters of the distribution.

Returns:

The marginal probability distribution.

Return type:

Distribution

is_available(distribution_name)

Check the availability of a probability distribution.

Parameters:

distribution_name (str) – The name of a class defining a distribution.

Returns:

The availability of the distribution.

Return type:

bool

property available_distributions: list[str]

The available probability distributions.