FiltSmoothStoppingCriterion

class probnum.filtsmooth.optim.FiltSmoothStoppingCriterion(atol=0.001, rtol=1e-06, maxit=1000)

Bases: probnum.StoppingCriterion

Stop iteration if absolute and relative tolerance are reached.

Methods Summary

__call__(error, reference)	Decide whether the stopping criterion is satisfied, which implies terminating of the iteration.
evaluate_error(error, reference)	Compute the normalised error.

Methods Documentation

__call__(error, reference)

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.

evaluate_error(error, reference)

Compute the normalised error.