RelativeMeanChange¶
- class probnum.quad.solvers.stopping_criteria.RelativeMeanChange(rel_tol)¶
Bases:
BQStoppingCriterion
Stop once the relative change of consecutive integral estimates are smaller than a tolerance.
The stopping criterion is: \(|\hat{F}_{c} - \hat{F}_{p}|/ |\hat{F}_{c}| \leq r\) where \(\hat{F}_{c}\) and \(\hat{F}_{p}\) are the integral estimates of the current and previous iteration respectively, and \(r\) is the relative tolerance.
- Parameters:
rel_tol (FloatLike) – Relative error tolerance on consecutive integral mean values.
Methods Summary
__call__
(bq_state, info)Check whether tracked quantities meet a desired terminal condition.
Methods Documentation
- __call__(bq_state, info)[source]¶
Check whether tracked quantities meet a desired terminal condition.
- Parameters:
bq_state (BQState) – State of the BQ belief.
info (BQIterInfo) – State of the BQ iteration.
- Returns:
Whether the stopping condition is met.
- Return type:
stopping_decision