Source code for gemseo.uncertainty.distributions.base_settings.exponential_settings

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# 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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# 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.
"""Base settings for defining an exponential distribution."""

from __future__ import annotations

from typing import Final

from pydantic import Field
from pydantic import PositiveFloat

from gemseo.uncertainty.distributions.base_distribution_settings import (
    BaseDistribution_Settings,
)

_LOC: Final[float] = 0.0
"""The default value of loc."""

_RATE: Final[float] = 1.0
"""The default value of rate."""




class BaseExponentialDistribution_Settings(BaseDistribution_Settings):  # noqa: N801
    """The base settings of an exponential distribution."""

    rate: PositiveFloat = Field(
        default=_RATE,
        description="The rate of the exponential random variable.",
    )

    loc: float = Field(
        default=_LOC,
        description="The location of the exponential random variable.",
    )