gemseo.uncertainty.distributions.scalar_distribution_mixin module#

A mixin for the probability distribution of a scalar random variable.

class ScalarDistributionMixin[source]#

Bases: object

A mixin for the probability distribution of a scalar random variable.

plot(show=True, save=False, file_path='', directory_path='', file_name='', file_extension='')[source]#

Plot both probability and cumulative density functions.

Parameters:
  • save (bool) --

    Whether to save the figure.

    By default it is set to False.

  • show (bool) --

    Whether to display the figure.

    By default it is set to True.

  • file_path (str | Path) --

    The path of the file to save the figure. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_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

JOINT_DISTRIBUTION_CLASS: ClassVar[type[BaseJointDistribution]]#

The class of the joint distribution associated with this distribution.