serif::solver::linear::Control Struct Reference

Accuracy is measured against the current right-hand side, independently of the initial guess. More...

#include <linear.hpp>

Public Member Functions
void	validate () const
	Reject invalid tolerances or iteration budgets before numerical work begins.
double	convergence_threshold (double right_hand_side_norm) const
	Return max(absolute tolerance, relative tolerance times the right-hand-side norm).

Public Attributes
double	relative_tolerance {1.0e-8}
double	absolute_tolerance {0.0}
int	maximum_iterations {100}

Detailed Description

Accuracy is measured against the current right-hand side, independently of the initial guess.

Member Function Documentation

convergence_threshold()

double serif::solver::linear::Control::convergence_threshold ( double right_hand_side_norm ) const

nodiscard

Return max(absolute tolerance, relative tolerance times the right-hand-side norm).

validate()

void serif::solver::linear::Control::validate

(

)

const

Reject invalid tolerances or iteration budgets before numerical work begins.

Member Data Documentation

absolute_tolerance

double serif::solver::linear::Control::absolute_tolerance {0.0}

maximum_iterations

int serif::solver::linear::Control::maximum_iterations {100}

relative_tolerance

double serif::solver::linear::Control::relative_tolerance {1.0e-8}

---

The documentation for this struct was generated from the following files:

• src/include/serif/solver/linear/linear.hpp
• src/lib/serif/solver/linear/linear.cpp