ResidualNormStoppingCriterion¶

class probnum.linalg.solvers.stopping_criteria.ResidualNormStoppingCriterion(atol=1e-05, rtol=1e-05)

Residual stopping criterion.

Terminate when the euclidean norm of the residual $$r_{i} = b - A x_{i}$$ is sufficiently small, i.e. if it satisfies $$\lVert r_i \rVert_2 \leq \max( \text{atol}, \text{rtol} \lVert b \rVert_2)$$.

Parameters

Methods Summary

 __call__(solver_state) Check whether the residual norm is smaller than the specified tolerance.

Methods Documentation

__call__(solver_state)[source]

Check whether the residual norm is smaller than the specified tolerance.

Parameters

solver_state (LinearSolverState) – Current state of the linear solver.

Return type

bool