uni20::linalg::SolveOptions< Real > Struct Template Reference

Real-scalar pivot policy for a square linear solve. More...

#include <solve_info.hpp>

Collaboration diagram for uni20::linalg::SolveOptions< Real >:

Public Attributes
Real	relative_pivot_tolerance = Real{}
	Reject nonzero pivots at or below this fraction of the original maximum entry magnitude.

Detailed Description

template<uni20::Real Real>
struct uni20::linalg::SolveOptions< Real >

Real-scalar pivot policy for a square linear solve.

A nonzero pivot is rejected when its magnitude divided by the maximum entry magnitude of the original coefficient matrix is at most relative_pivot_tolerance. This is not a condition estimate. Zero (the default) rejects only exact zero pivots. The tolerance must be finite and nonnegative. A positive threshold is application policy: it can reject accurately solvable systems whose components have different scales. For nonempty problems, nonfinite inputs/results are reported regardless of tolerance, including magnitude overflow.

Member Data Documentation

relative_pivot_tolerance

template<uni20::Real Real>

Real uni20::linalg::SolveOptions< Real >::relative_pivot_tolerance = Real{}

Reject nonzero pivots at or below this fraction of the original maximum entry magnitude.

---

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

• solve_info.hpp