StoppingCriterion

class probnum.filtsmooth.StoppingCriterion(atol=0.001, rtol=1e-06, maxit=1000)[source]

Bases: object

Stop iteration if absolute and relative tolerance are reached.

Methods Summary

evaluate_error(error, reference)

Compute the normalised error.

terminate(error, reference)

Decide whether the stopping criterion is satisfied, which implies terminating of the iteration.

Methods Documentation

evaluate_error(error, reference)[source]

Compute the normalised error.

terminate(error, reference)[source]

Decide whether the stopping criterion is satisfied, which implies terminating of the iteration.

If the error is sufficiently small (with respect to atol, rtol and the reference), return True. Else, return False. Throw a runtime error if the maximum number of iterations is reached.