33#ifndef GKO_PUBLIC_CORE_LOG_CONVERGENCE_HPP_
34#define GKO_PUBLIC_CORE_LOG_CONVERGENCE_HPP_
40#include <ginkgo/core/log/logger.hpp>
41#include <ginkgo/core/matrix/dense.hpp>
42#include <ginkgo/core/stop/criterion.hpp>
65template <
typename ValueType = default_precision>
70 const LinOp* residual,
const LinOp* residual_norm,
71 const LinOp* solution,
const uint8& stopping_id,
73 const bool&
one_changed,
const bool& all_stopped)
const override;
77 const LinOp* residual,
const LinOp* residual_norm,
79 const uint8& stopping_id,
const bool& set_finalized,
81 const bool& all_stopped)
const override;
85 const LinOp* residual,
86 const LinOp* residual_norm,
105 GKO_DEPRECATED(
"use single-parameter create")
109 Logger::iteration_complete_mask)
127 static std::unique_ptr<Convergence>
create(
129 Logger::iteration_complete_mask)
153 return num_iterations_;
170 return residual_norm_.get();
180 return implicit_sq_resnorm_.get();
191 GKO_DEPRECATED(
"use single-parameter constructor")
195 Logger::iteration_complete_mask)
205 explicit Convergence(
207 Logger::iteration_complete_mask)
212 mutable bool convergence_status_{
false};
214 mutable std::unique_ptr<LinOp> residual_{};
215 mutable std::unique_ptr<LinOp> residual_norm_{};
216 mutable std::unique_ptr<LinOp> implicit_sq_resnorm_{};
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:644
Definition lin_op.hpp:146
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:187
Convergence is a Logger which logs data strictly from the criterion_check_completed event.
Definition convergence.hpp:66
bool has_converged() const noexcept
Returns true if the solver has converged.
Definition convergence.hpp:139
static std::unique_ptr< Convergence > create(const mask_type &enabled_events=Logger::criterion_events_mask|Logger::iteration_complete_mask)
Creates a convergence logger.
Definition convergence.hpp:127
const size_type & get_num_iterations() const noexcept
Returns the number of iterations.
Definition convergence.hpp:151
void on_criterion_check_completed(const stop::Criterion *criterion, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *implicit_sq_resnorm, const LinOp *solution, const uint8 &stopping_id, const bool &set_finalized, const array< stopping_status > *status, const bool &one_changed, const bool &all_stopped) const override
stop::Criterion's check completed event.
void on_criterion_check_completed(const stop::Criterion *criterion, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *solution, const uint8 &stopping_id, const bool &set_finalized, const array< stopping_status > *status, const bool &one_changed, const bool &all_stopped) const override
stop::Criterion's check completed event.
const LinOp * get_residual() const noexcept
Returns the residual.
Definition convergence.hpp:161
const LinOp * get_residual_norm() const noexcept
Returns the residual norm.
Definition convergence.hpp:168
void on_iteration_complete(const LinOp *solver, const LinOp *b, const LinOp *x, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *implicit_resnorm_sq, const array< stopping_status > *status, bool stopped) const override
Register the iteration_complete event which logs every completed iterations.
static std::unique_ptr< Convergence > create(std::shared_ptr< const Executor >, const mask_type &enabled_events=Logger::criterion_events_mask|Logger::iteration_complete_mask)
Creates a convergence logger.
Definition convergence.hpp:106
void reset_convergence_status()
Resets the convergence status to false.
Definition convergence.hpp:144
const LinOp * get_implicit_sq_resnorm() const noexcept
Returns the implicit squared residual norm.
Definition convergence.hpp:178
Definition logger.hpp:104
static constexpr mask_type criterion_events_mask
Bitset Mask which activates all criterion events.
Definition logger.hpp:664
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:64
@ criterion
Stopping criterion events.
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:149
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120