OrderStatisticsMarginalChecker¶
-
class
OrderStatisticsMarginalChecker
(*args)¶ Compatibility tests of marginals with respect to the order statistics constraint.
- Parameters
- collsequence of
Distribution
The marginals which are tested with respect to the order in the context of the maximum order statistics distribution.
- collsequence of
Notes
Three tests are performed. We note the range of . The tests are :
Test 1 checks that and for all .
Test 2 discretizes with where is defined in the
ResourceMap
with OSMC-OptimizationEpsilon. By default, . Test 2 checks that:where is defined in the
ResourceMap
with OSMC-QuantileIteration. By default, .Test 3 checks that:
using the TNC algorithm.
Examples
Create the test checker:
>>> import openturns as ot >>> coll = [ot.Uniform(-1.0, 1.0), ot.Uniform(-0.5, 1.5)] >>> testChecker = ot.OrderStatisticsMarginalChecker(coll)
Check the compatibility:
>>> compatibilityResult = testChecker.isCompatible()
Methods
buildPartition
(self)Accessor to the partition in independent marginal sets if any.
check
(self)Give the reasons of uncompatibility of the margins if any.
getClassName
(self)Accessor to the object’s name.
isCompatible
(self)Result of the compatibility tests.
getOptimizationAlgorithm
setOptimizationAlgorithm
-
__init__
(self, \*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
buildPartition
(self)¶ Accessor to the partition in independent marginal sets if any.
- Returns
- indepMarginals
Indices
Indicates the indices that build some independent sets of marginals. If we note then the sub random vectors , and are independent. This information is automatically used by OpenTURNS to build the appropriated maximum entropy order statistics distribution.
- indepMarginals
-
check
(self)¶ Give the reasons of uncompatibility of the margins if any.
Notes
This method throws an exception in case of compatibility problem with a message indicating the first compatibility problem arised.
-
getClassName
(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
isCompatible
(self)¶ Result of the compatibility tests.
- Returns
- resCompatibilitybool
The final result of the 3 compatibility tests with respect to the order constraint.