MaxIterationsStoppingCriterion

class probnum.linalg.solvers.stopping_criteria.MaxIterationsStoppingCriterion(maxiter=None)

Bases: LinearSolverStoppingCriterion

Stop after a maximum number of iterations.

Stop when the solver has taken a maximum number of steps. If None is specified, defaults to \(10n\), where \(n\) is the dimension of the solution to the linear system.

Parameters

maxiter (Optional[int]) – Maximum number of steps the solver should take.

Methods Summary

__call__(solver_state)

Check whether the maximum number of iterations has been reached.

Methods Documentation

__call__(solver_state)

Check whether the maximum number of iterations has been reached.

Parameters

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

Return type

bool