#include <iteration.hpp>

Inheritance diagram for teqp::iteration::StoppingCondition:

Public Member Functions
virtual StoppingConditionReason	stop (const StoppingData &)=0

virtual std::string	desc ()=0

Detailed Description

The base class for a stopping condition test in iteration

The function stop returns either a StoppingConditionReason::keep_going to indicate that the stopping condition is not satisfied or another enumerated value to indicate whether successful or a failure

Definition at line 37 of file iteration.hpp.

Member Function Documentation

◆ desc()

virtual std::string teqp::iteration::StoppingCondition::desc ( )

pure virtual

Implemented in teqp::iteration::MaxAbsErrorCondition, teqp::iteration::MinRelStepsizeCondition, teqp::iteration::NanXDXErrorCondition, teqp::iteration::NegativeXErrorCondition, and teqp::iteration::StepCountErrorCondition.

◆ stop()

virtual StoppingConditionReason teqp::iteration::StoppingCondition::stop ( const StoppingData & )