gemseo / uncertainty / distributions / scipy

Show inherited members

weibull module

The SciPy-based Weibull distribution.

class gemseo.uncertainty.distributions.scipy.weibull.SPWeibullDistribution(variable='x', location=0.0, scale=1.0, shape=1.0, use_weibull_min=True, dimension=1)[source]

Bases: SPDistribution

The SciPy-based Weibull distribution.

Examples

>>> from gemseo.uncertainty.distributions.scipy.weibull import (
...     SPWeibullDistribution,
... )
>>> distribution = SPWeibullDistribution("u", 0.5, 1.0, 2.0)
>>> print(distribution)
weibull_min(location=1, scale=2, shape=0.5)
Parameters:
  • variable (str) –

    The name of the random variable.

    By default it is set to “x”.

  • location (float) –

    The location parameter of the Weibull distribution.

    By default it is set to 0.0.

  • scale (float) –

    The scale parameter of the Weibull distribution.

    By default it is set to 1.0.

  • shape (float) –

    The shape parameter of the Weibull distribution.

    By default it is set to 1.0.

  • use_weibull_min (bool) –

    Whether to use the Weibull minimum extreme value distribution (the support of the random variable is \([\gamma,+\infty[\)) or the Weibull maximum extreme value distribution (the support of the random variable is \(]-\infty[,\gamma]\)).

    By default it is set to True.

  • dimension (int) –

    The dimension of the random variable. If greater than 1, the probability distribution is applied to all components of the random variable under the hypothesis that these components are stochastically independent. To be removed in a future version; use a BaseJointDistribution instead.

    By default it is set to 1.

dimension: int

The number of dimensions of the random variable.

distribution: type

The probability distribution of the random variable.

distribution_name: str

The name of the probability distribution.

marginals: list[type]

The marginal distributions of the components of the random variable.

math_lower_bound: ndarray

The mathematical lower bound of the random variable.

math_upper_bound: ndarray

The mathematical upper bound of the random variable.

num_lower_bound: ndarray

The numerical lower bound of the random variable.

num_upper_bound: ndarray

The numerical upper bound of the random variable.

parameters: tuple[Any] | dict[str, Any]

The parameters of the probability distribution.

standard_parameters: dict[str, str] | None

The standard representation of the parameters of the distribution, used for its string representation.

transformation: str

The transformation applied to the random variable, e.g. ‘sin(x)’.

variable_name: str

The name of the random variable.