WeibullMinMuSigma¶
-
class
WeibullMinMuSigma
(*args)¶ WeibullMin distribution parameters.
- Parameters
- mufloat
Mean.
- sigmafloat
Standard deviation
.
- gammafloat, optional
Shift parameter
.
See also
Notes
The native parameters
and
are searched such as:
The
parameter is the same.
Examples
Create the parameters
of the WeibullMin distribution:
>>> import openturns as ot >>> parameters = ot.WeibullMinMuSigma(1.3, 1.23, -0.5)
Convert parameters into the native parameters
:
>>> print(parameters.evaluate()) [1.99222,1.48961,-0.5]
Methods
__call__
(self, inP)Call self as a function.
evaluate
(self)Compute native parameters values.
getClassName
(self)Accessor to the object’s name.
getDescription
(self)Get the description of the parameters.
getDistribution
(self)Build a distribution based on a set of native parameters.
getId
(self)Accessor to the object’s id.
getName
(self)Accessor to the object’s name.
getShadowedId
(self)Accessor to the object’s shadowed id.
getValues
(self)Accessor to the parameters values.
getVisibility
(self)Accessor to the object’s visibility state.
gradient
(self)Get the gradient.
hasName
(self)Test if the object is named.
hasVisibleName
(self)Test if the object has a distinguishable name.
inverse
(self, inP)Convert to native parameters.
setName
(self, name)Accessor to the object’s name.
setShadowedId
(self, id)Accessor to the object’s shadowed id.
setValues
(self, values)Accessor to the parameters values.
setVisibility
(self, visible)Accessor to the object’s visibility state.
-
__init__
(self, \*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName
(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getDescription
(self)¶ Get the description of the parameters.
- Returns
- collection
Description
List of parameters names.
- collection
-
getDistribution
(self)¶ Build a distribution based on a set of native parameters.
- Returns
- distribution
Distribution
Distribution built with the native parameters.
- distribution
-
getId
(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getName
(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getShadowedId
(self)¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getVisibility
(self)¶ Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
-
gradient
(self)¶ Get the gradient.
- Returns
- gradient
Matrix
The gradient of the transformation of the native parameters into the new parameters.
- gradient
Notes
If we note
the native parameters and
the new ones, then the gradient matrix is
.
-
hasName
(self)¶ Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
-
hasVisibleName
(self)¶ Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
-
inverse
(self, inP)¶ Convert to native parameters.
- Parameters
- inPsequence of float
The non-native parameters.
- Returns
- outP
Point
The native parameters.
- outP
-
setName
(self, name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setShadowedId
(self, id)¶ Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
-
setValues
(self, values)¶ Accessor to the parameters values.
- Parameters
- valuessequence of float
List of parameters values.
-
setVisibility
(self, visible)¶ Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.