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


The \doxylink{classgko_1_1stop_1_1RelativeResidualNorm}{Relative\+Residual\+Norm} class is a stopping criterion which stops the iteration process when the residual norm is below a certain threshold relative to the norm of the right-\/hand side, i.\+e.  




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



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


Collaboration diagram for gko::\+stop::\+Relative\+Residual\+Norm\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1stop_1_1RelativeResidualNorm__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \doxymbox{\hyperlink{structgko_1_1stop_1_1RelativeResidualNorm_1_1parameters__type}{parameters\+\_\+type}}
\item 
class \doxymbox{\hyperlink{classgko_1_1stop_1_1RelativeResidualNorm_1_1Factory}{Factory}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1stop_1_1RelativeResidualNorm_a8a32d057a6edec05ed3e7accc8fec04d}\label{classgko_1_1stop_1_1RelativeResidualNorm_a8a32d057a6edec05ed3e7accc8fec04d} 
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_1RelativeResidualNorm_ac620df5b1cef7d3cf86a4a3789a1da7e}\label{classgko_1_1stop_1_1RelativeResidualNorm_ac620df5b1cef7d3cf86a4a3789a1da7e} 
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_1RelativeResidualNorm_a9270230b90728ceac4b6ceb5314d627f}\label{classgko_1_1stop_1_1RelativeResidualNorm_a9270230b90728ceac4b6ceb5314d627f} 
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_1RelativeResidualNorm_a1401d4ba5cd0a3dcc437586895537c22}\label{classgko_1_1stop_1_1RelativeResidualNorm_a1401d4ba5cd0a3dcc437586895537c22} 
const \doxymbox{\hyperlink{structgko_1_1stop_1_1RelativeResidualNorm_1_1parameters__type}{parameters\+\_\+type}} \& {\bfseries get\+\_\+parameters} () const
\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1stop_1_1RelativeResidualNorm_add5b5f167ed7e8cbf19d6810914a1ad6}\label{classgko_1_1stop_1_1RelativeResidualNorm_add5b5f167ed7e8cbf19d6810914a1ad6} 
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::\+\+Relative\+Residual\+Norm$<$ Value\+Type $>$}
The \doxylink{classgko_1_1stop_1_1RelativeResidualNorm}{Relative\+Residual\+Norm} class is a stopping criterion which stops the iteration process when the residual norm is below a certain threshold relative to the norm of the right-\/hand side, i.\+e. 

when norm(residual) /\+ norm(right\+\_\+hand\+\_\+side) \texorpdfstring{$<$}{<} threshold. For better performance, the checks are run thanks to kernels on the executor where the algorithm is executed.

\begin{DoxyNote}{Note}
To use this stopping criterion there are some dependencies. The constructor depends on {\ttfamily b} in order to compute the norm of the right-\/hand side. 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}
