![]() |
Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
|
This class is used to keep track of the stopping status of one vector. More...
#include <ginkgo/core/stop/stopping_status.hpp>
Public Member Functions | |
bool | has_stopped () const noexcept |
Check if any stopping criteria was fulfilled. | |
bool | has_converged () const noexcept |
Check if convergence was reached. | |
bool | is_finalized () const noexcept |
Check if the corresponding vector stores the finalized result. | |
uint8 | get_id () const noexcept |
Get the id of the stopping criterion which caused the stop. | |
void | reset () noexcept |
Clear all flags. | |
void | stop (uint8 id, bool set_finalized=true) noexcept |
Call if a stop occurred due to a hard limit (and convergence was not reached). | |
void | converge (uint8 id, bool set_finalized=true) noexcept |
Call if convergence occurred. | |
void | finalize () noexcept |
Set the result to be finalized (it needs to be stopped or converged first). | |
Friends | |
bool | operator== (const stopping_status &x, const stopping_status &y) noexcept |
Checks if two stopping statuses are equivalent. | |
bool | operator!= (const stopping_status &x, const stopping_status &y) noexcept |
Checks if two stopping statuses are different. | |
This class is used to keep track of the stopping status of one vector.
Call if convergence occurred.
id | id of the stopping criteria. |
set_finalized | Controls if the current version should count as finalized (set to true) or not (set to false). |
References has_stopped().
|
inlinenoexcept |
Get the id of the stopping criterion which caused the stop.
Referenced by has_stopped().
|
inlinenoexcept |
Check if convergence was reached.
|
inlinenoexcept |
Check if any stopping criteria was fulfilled.
References get_id().
Referenced by converge(), finalize(), and stop().
|
inlinenoexcept |
Check if the corresponding vector stores the finalized result.
Call if a stop occurred due to a hard limit (and convergence was not reached).
id | id of the stopping criteria. |
set_finalized | Controls if the current version should count as finalized (set to true) or not (set to false). |
References has_stopped().
|
friend |
Checks if two stopping statuses are different.
x | a stopping status |
y | a stopping status |
!(x == y)
|
friend |
Checks if two stopping statuses are equivalent.
x | a stopping status |
y | a stopping status |
x
and y
have the same mask and converged and finalized state