Source code for gemseo.uncertainty.distributions.factory

# Copyright 2021 IRT Saint Exupéry,
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
# Contributors:
#    INITIAL AUTHORS - initial API and implementation and/or initial
#                           documentation
#        :author: Francois Gallard, Matthias De Lozzo
"""Module containing a factory to create an instance of :class:`.Distribution`."""
from __future__ import annotations

from typing import Optional
from typing import Union

from gemseo.core.factory import Factory
from gemseo.uncertainty.distributions.distribution import Distribution
from gemseo.uncertainty.distributions.distribution import ParametersType
from gemseo.uncertainty.distributions.distribution import StandardParametersType

DistributionParametersType = Union[
    int, ParametersType, Optional[StandardParametersType], float

[docs]class DistributionFactory: """Factory to build instances of :class:`.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) """ def __init__(self) -> None: # noqa: D107 self.factory = Factory(Distribution, ("gemseo.uncertainty.distributions",))
[docs] def create( self, distribution_name: str, variable: str, **parameters: DistributionParametersType, ) -> Distribution: """Create a probability distribution for a given random variable. Args: distribution_name: The name of a class defining a distribution. variable: The name of the random variable. **parameters: The parameters of the distribution. Returns: The probability distribution instance. """ return self.factory.create(distribution_name, variable=variable, **parameters)
@property def available_distributions(self) -> list[str]: """The available probability distributions.""" return self.factory.classes
[docs] def is_available( self, distribution_name: str, ) -> bool: """Check the availability of a probability distribution. Args: distribution_name: The name of a class defining a distribution. Returns: The availability of the distribution. """ return self.factory.is_available(distribution_name)