\doxysection{gko::\+stop::\+Implicit\+Residual\+Norm\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>} Class Template Reference}
\hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm}{}\label{classgko_1_1stop_1_1ImplicitResidualNorm}\index{gko::stop::ImplicitResidualNorm$<$ ValueType $>$@{gko::stop::ImplicitResidualNorm$<$ ValueType $>$}}


The \doxylink{classgko_1_1stop_1_1ImplicitResidualNorm}{Implicit\+Residual\+Norm} class is a stopping criterion which stops the iteration process when the implicit residual norm is below a certain threshold relative to.  




{\ttfamily \+\#include $<$ginkgo/\+core/\+stop/\+residual\+\_\+norm.\+hpp$>$}



Inheritance diagram for gko::\+stop::\+Implicit\+Residual\+Norm\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1stop_1_1ImplicitResidualNorm__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+stop::\+Implicit\+Residual\+Norm\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1stop_1_1ImplicitResidualNorm__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \doxymbox{\hyperlink{structgko_1_1stop_1_1ImplicitResidualNorm_1_1parameters__type}{parameters\+\_\+type}}
\item 
class \doxymbox{\hyperlink{classgko_1_1stop_1_1ImplicitResidualNorm_1_1Factory}{Factory}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm_afe3c37b9652174139c892e7538341c00}\label{classgko_1_1stop_1_1ImplicitResidualNorm_afe3c37b9652174139c892e7538341c00} 
using {\bfseries Complex\+Vector} = \doxymbox{\hyperlink{classgko_1_1matrix_1_1Dense}{matrix::\+\+Dense}}$<$\doxymbox{\hyperlink{namespacegko_a4ad20e5381a84928753efde0b2bc7f85}{to\+\_\+complex}}$<$Value\+Type$>$$>$
\item 
\Hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm_aa7034ac9416d7cf7698ec933f6705e2b}\label{classgko_1_1stop_1_1ImplicitResidualNorm_aa7034ac9416d7cf7698ec933f6705e2b} 
using {\bfseries Norm\+Vector} = \doxymbox{\hyperlink{classgko_1_1matrix_1_1Dense}{matrix::\+\+Dense}}$<$\doxymbox{\hyperlink{namespacegko_a107302a750bfa82a2107c77293f791c9}{remove\+\_\+complex}}$<$Value\+Type$>$$>$
\item 
\Hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm_a441730ef9ffa2fe11263141022ea6f22}\label{classgko_1_1stop_1_1ImplicitResidualNorm_a441730ef9ffa2fe11263141022ea6f22} 
using {\bfseries Vector} = \doxymbox{\hyperlink{classgko_1_1matrix_1_1Dense}{matrix::\+\+Dense}}$<$Value\+Type$>$
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm_a4675a69010dd3bdef84703e5e7876acf}\label{classgko_1_1stop_1_1ImplicitResidualNorm_a4675a69010dd3bdef84703e5e7876acf} 
const \doxymbox{\hyperlink{structgko_1_1stop_1_1ImplicitResidualNorm_1_1parameters__type}{parameters\+\_\+type}} \& {\bfseries get\+\_\+parameters} () const
\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1stop_1_1ImplicitResidualNorm_ac7072f50437a5bf356ca5df564e773ad}\label{classgko_1_1stop_1_1ImplicitResidualNorm_ac7072f50437a5bf356ca5df564e773ad} 
static auto {\bfseries build} () -\/$>$ decltype(\doxymbox{\hyperlink{classgko_1_1EnableDefaultFactory_a1d077101d9e788e6c65f088612d14cc3}{Factory::\+create}}())
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename Value\+Type = default\+\_\+precision$>$\newline
class gko::\+stop::\+\+Implicit\+Residual\+Norm$<$ Value\+Type $>$}
The \doxylink{classgko_1_1stop_1_1ImplicitResidualNorm}{Implicit\+Residual\+Norm} class is a stopping criterion which stops the iteration process when the implicit residual norm is below a certain threshold relative to. 


\begin{DoxyEnumerate}
\item the norm of the right-\/hand side, implicit\+\_\+resnorm $\leq$ \texorpdfstring{$<$}{<} threshold \texorpdfstring{$\ast$}{*} norm(right\+\_\+hand\+\_\+side)
\item the initial residual, implicit\+\_\+resnorm $\leq$ threshold \texorpdfstring{$\ast$}{*} norm(initial\+\_\+residual) .
\item one, implicit\+\_\+resnorm $\leq$ threshold.
\end{DoxyEnumerate}

\begin{DoxyNote}{Note}
To use this stopping criterion there are some dependencies. The constructor depends on either {\ttfamily b} or the {\ttfamily initial\+\_\+residual} in order to compute their norms. If this is not correctly provided, an exception ::\+gko::\+\+Not\+Supported() is thrown. 
\end{DoxyNote}


The documentation for this class was generated from the following file:\+\begin{DoxyCompactItemize}
\item 
ginkgo/\+core/\+stop/\+residual\+\_\+norm.\+hpp\end{DoxyCompactItemize}
