gemseo.uncertainty.distributions.base_settings.log_normal_settings module#

Base settings for defining a log-normal distribution.

Settings BaseLogNormalDistribution_Settings(*, mu=1.0, sigma=1.0, location=0.0, set_log=False)[source]#

Bases: BaseDistribution_Settings

The base settings of a log-normal distribution.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • mu (float) --

    By default it is set to 1.0.

  • sigma (Annotated[float, Gt(gt=0)]) --

    By default it is set to 1.0.

  • location (float) --

    By default it is set to 0.0.

  • set_log (bool) --

    By default it is set to False.

Return type:

None

location: float = 0.0#

The location of the log-normal random variable.

mu: float = 1.0#

Either the mean of the log-normal random variable or that of its logarithm when set_log is True.

set_log: bool = False#

Whether mu and sigma apply to the logarithm of the log-normal random variable. Otherwise, mu and sigma apply to the log-normal random variable directly.

sigma: PositiveFloat = 1.0#

Either the standard deviation of the log-normal random variable or that of its logarithm when set_log is True.

Constraints:

  • gt = 0