numerics/api/solver__result_8hpp_source.html

/// @file solver_result.hpp

/// @brief Common result type shared by all iterative solvers

#pragma once

#include "core/types.hpp"


namespace num {


struct SolverResult {

    idx  iterations;   ///< Number of iterations performed

    real residual;     ///< Final residual norm ||b - Ax||

    bool converged;    ///< Whether tolerance was met

};


} // namespace num

types.hpp
Core type definitions.

num
Definition quadrature.hpp:8

num::real
double real
Definition types.hpp:10

num::idx
std::size_t idx
Definition types.hpp:11

num::SolverResult
Definition solver_result.hpp:8

num::SolverResult::converged
bool converged
Whether tolerance was met.
Definition solver_result.hpp:11

num::SolverResult::iterations
idx iterations
Number of iterations performed.
Definition solver_result.hpp:9

num::SolverResult::residual
real residual
Final residual norm ||b - Ax||.
Definition solver_result.hpp:10