ReliabilityBenchmarkProblem¶
- class ReliabilityBenchmarkProblem(name, thresholdEvent, probability)¶
Class to define a benchmark problem.
Methods
Return the beta of the reliability problem.
getEvent
()Return the event.
getName
()Return the name of the problem.
Return the probability.
Convert the object into a string, with full details.
- __init__(name, thresholdEvent, probability)¶
Create a reliability problem.
The essential information is the exact probability. This should be as accurate as possible. The best possible accuracy for a Python float is 53 significant (binary) bits, which approximately corresponds to 15-17 decimal digits. If this accuracy is not available, then a reference value may be used, for example from a large Monte-Carlo sample.
In general, the exact probability should be a constant value, e.g. 0.123456789. However, we may be forced to compute this probability at the creation of the problem, for example if the threshold of the problem can be set at the creation of the object. In this case, the unit test must check that the default value of the parameters correspond to a reference, constant, value.
- Parameters:
- namestr
The name of the benchmark problem. This is a short string, typically less than a dozen of caracters.
- thresholdEventot.ThresholdEvent
The event.
- probabilityfloat
The exact probability.
Examples
>>> import otbenchmark as otb >>> problem = otb.ReliabilityBenchmarkProblem( ... name, thresholdEvent, probability)
- computeBeta()¶
Return the beta of the reliability problem.
This is the quantile of the probability of a standard gaussian distribution.
- Parameters:
- None.
- Returns:
- beta: float
The beta of the problem.
- getEvent()¶
Return the event.
- Parameters:
- None.
- Returns:
- event: ot.ThresholdEvent
The event.
- getName()¶
Return the name of the problem.
- Parameters:
- None.
- Returns:
- name: str
The name of the problem.
- getProbability()¶
Return the probability.
- Parameters:
- None.
- Returns:
- probability: float
The probability of the event.
- toFullString()¶
Convert the object into a string, with full details.
- Parameters:
- None.
- Returns:
- s: str
The string of the problem.