iterative_algorithm_result.h

Go to the documentation of this file.

#ifndef ITERATIVE_ALGORITHM_RESULT_H
#define ITERATIVE_ALGORITHM_RESULT_H
 
#include "bitrl/bitrl_types.h"
#include <chrono>
#include <ostream>
#include <vector>
 
namespace bitrl
{
namespace utils
{
 
struct IterativeAlgorithmResult
{
 
    real_t tolerance;
 
    real_t residual;
 
    uint_t num_iterations;
 
    bool converged = false;
 
    std::chrono::duration<real_t> total_time;
 
    std::vector<real_t> residuals;
 
    IterativeAlgorithmResult() = default;
 
    IterativeAlgorithmResult(real_t tol, real_t res, uint_t nitrs,
                             std::chrono::duration<real_t> time);
 
    std::ostream &print(std::ostream &out) const;
};
 
inline std::ostream &operator<<(std::ostream &out, const IterativeAlgorithmResult &result)
{
    return result.print(out);
}
 
} // namespace utils
} // namespace bitrl
#endif // ITERATIVE_ALGORITHM_RESULT_H