base_joint module¶
Joint probability distribution.
Overview¶
BaseJointDistribution
is an abstract class
implementing the concept of joint probability distribution.
The joint probability distribution of a set of random variables is the probability distribution of the random vector consisting of these random variables.
It takes into account both the marginal probability distributions of these random variables and their dependency structure.
A BaseJointDistribution
is defined
from a list of BaseDistribution
instances
defining the marginals of the random variables
and a copula defining the dependency structure between them.
Note
A copula is a mathematical function used to define the dependence between random variables from their cumulative density functions. See more.
By definition, a joint probability distribution is a probability distribution
Therefore, BaseJointDistribution
inherits
from the abstract class BaseDistribution
.
Construction¶
The BaseJointDistribution
of a list of given uncertain variables is built
from a list of BaseDistribution
objects
implementing the probability distributions of these variables
and from a copula.
Capabilities¶
Because BaseJointDistribution
inherits from BaseDistribution
,
we can easily get statistics, such as BaseJointDistribution.mean
,
BaseJointDistribution.standard_deviation
.
We can also get the numerical BaseJointDistribution.range
and
mathematical BaseJointDistribution.support
.
Note
We call mathematical support the set of values that the random variable can take in theory, e.g. \(]-\infty,+\infty[\) for a Gaussian variable, and numerical range the set of values that it can take in practice, taking into account the values rounded to zero double precision. Both support and range are described in terms of lower and upper bounds
We can also evaluate the cumulative density function
(BaseJointDistribution.compute_cdf()
)
for the different marginals of the random variable,
as well as the inverse cumulative density function
(BaseJointDistribution.compute_inverse_cdf()
). We can plot them,
either for a given marginal (BaseJointDistribution.plot()
)
or for all marginals (BaseJointDistribution.plot_all()
).
Lastly, we can compute realizations of the random variable
by means of the BaseJointDistribution.compute_samples()
method.
- class gemseo.uncertainty.distributions.base_joint.BaseJointDistribution(distributions, copula=None, variable='')[source]¶
Bases:
BaseDistribution
Joint probability distribution.
- Parameters:
distributions (Sequence[BaseDistribution]) – The marginal distributions.
copula (Any) – A copula distribution defining the dependency structure between random variables; if
None
, consider an independent copula.variable (str) –
The name of the variable, if any; otherwise, concatenate the names of the random variables defined by
distributions
.By default it is set to “”.
- abstract compute_cdf(vector)¶
Evaluate the cumulative density function (CDF).
Evaluate the CDF of the components of the random variable for a given realization of this random variable.
- abstract compute_inverse_cdf(vector)¶
Evaluate the inverse of the cumulative density function (ICDF).
- plot(index=0, show=True, save=False, file_path='', directory_path='', file_name='', file_extension='')¶
Plot both probability and cumulative density functions for a given component.
- Parameters:
index (int) –
The index of a component of the random variable.
By default it is set to 0.
save (bool) –
If
True
, save the figure.By default it is set to False.
show (bool) –
If
True
, display the figure.By default it is set to True.
file_path (str | Path) –
The path of the file to save the figures. If the extension is missing, use
file_extension
. If empty, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to “”.
directory_path (str | Path) –
The path of the directory to save the figures. If empty, use the current working directory.
By default it is set to “”.
file_name (str) –
The name of the file to save the figures. If empty, use a default one generated by the post-processing.
By default it is set to “”.
file_extension (str) –
A file extension, e.g.
'png'
,'pdf'
,'svg'
, … If empty, use a default file extension.By default it is set to “”.
- Returns:
The figure.
- Return type:
Figure
- plot_all(show=True, save=False, file_path='', directory_path='', file_name='', file_extension='')¶
Plot both probability and cumulative density functions for all components.
- Parameters:
save (bool) –
If
True
, save the figure.By default it is set to False.
show (bool) –
If
True
, display the figure.By default it is set to True.
file_path (str | Path) –
The path of the file to save the figures. If the extension is missing, use
file_extension
. If empty, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to “”.
directory_path (str | Path) –
The path of the directory to save the figures. If empty, use the current working directory.
By default it is set to “”.
file_name (str) –
The name of the file to save the figures. If empty, use a default one generated by the post-processing.
By default it is set to “”.
file_extension (str) –
A file extension, e.g.
'png'
,'pdf'
,'svg'
, … If empty, use a default file extension.By default it is set to “”.
- Returns:
The figures.
- Return type:
list[Figure]
- JOINT_DISTRIBUTION_CLASS: ClassVar[type[BaseJointDistribution] | None] = None¶
The class of the joint distribution associated with this distribution, if any.
- 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.
- property range: list[ndarray]¶
The numerical range.
The numerical range is the interval defined by the lower and upper bounds numerically reachable by the random variable.
Here, the numerical range of the random variable is defined by one array for each component of the random variable, whose first element is the lower bound of this component while the second one is its upper bound.
- standard_parameters: dict[str, str] | None¶
The standard representation of the parameters of the distribution, used for its string representation.
- property support: list[ndarray]¶
The mathematical support.
The mathematical support is the interval defined by the theoretical lower and upper bounds of the random variable.
Here, the mathematical range of the random variable is defined by one array for each component of the random variable, whose first element is the lower bound of this component while the second one is its upper bound.