exponential module¶
Class to create an exponential distribution from the SciPy library.
This class inherits from SPDistribution
.
- class gemseo.uncertainty.distributions.scipy.exponential.SPExponentialDistribution(variable, rate=1.0, loc=0.0, dimension=1)[source]
Bases:
SPDistribution
Create an exponential distribution.
Example
>>> from gemseo.uncertainty.distributions.scipy.exponential import ( ... SPExponentialDistribution ... ) >>> distribution = SPExponentialDistribution('x', 2, 3) >>> print(distribution) expon(loc=3, scale=0.5)
- Parameters:
variable (str) – The name of the exponential random variable.
rate (float) –
The rate of the exponential random variable.
By default it is set to 1.0.
loc (float) –
The location of the exponential random variable.
By default it is set to 0.0.
dimension (int) –
The dimension of the exponential random variable.
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.
- 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.
- 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.