\doxysection{gko::\+stop::\+Criterion\+Args Struct Reference}
\hypertarget{structgko_1_1stop_1_1CriterionArgs}{}\label{structgko_1_1stop_1_1CriterionArgs}\index{gko::stop::CriterionArgs@{gko::stop::CriterionArgs}}


This struct is used to pass parameters to the Enable\+Default\+Criterion\+Factory\+Criterion\+Factory::\+generate() method.  




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



Collaboration diagram for gko::\+stop::\+Criterion\+Args:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=340pt]{structgko_1_1stop_1_1CriterionArgs__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1stop_1_1CriterionArgs_aee534b8a229d17a5cca30e6fe2dcc05e}\label{structgko_1_1stop_1_1CriterionArgs_aee534b8a229d17a5cca30e6fe2dcc05e} 
{\bfseries Criterion\+Args} (std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ system\+\_\+matrix, std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ b, const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} \texorpdfstring{$\ast$}{*}x, const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} \texorpdfstring{$\ast$}{*}initial\+\_\+residual=nullptr)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1stop_1_1CriterionArgs_a2aa22bea76fd64352a446cf6c5570807}\label{structgko_1_1stop_1_1CriterionArgs_a2aa22bea76fd64352a446cf6c5570807} 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ {\bfseries system\+\_\+matrix}
\item 
\Hypertarget{structgko_1_1stop_1_1CriterionArgs_a994457497657a0308c5343e711ec4c3e}\label{structgko_1_1stop_1_1CriterionArgs_a994457497657a0308c5343e711ec4c3e} 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ {\bfseries b}
\item 
\Hypertarget{structgko_1_1stop_1_1CriterionArgs_a766a5c79ca77e74703888786e0011a73}\label{structgko_1_1stop_1_1CriterionArgs_a766a5c79ca77e74703888786e0011a73} 
const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} \texorpdfstring{$\ast$}{*} {\bfseries x}
\item 
\Hypertarget{structgko_1_1stop_1_1CriterionArgs_af7233105d01a9b055b15652daf179a67}\label{structgko_1_1stop_1_1CriterionArgs_af7233105d01a9b055b15652daf179a67} 
const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} \texorpdfstring{$\ast$}{*} {\bfseries initial\+\_\+residual}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This struct is used to pass parameters to the Enable\+Default\+Criterion\+Factory\+Criterion\+Factory::\+generate() method. 

It is the Components\+Type of \doxylink{namespacegko_1_1stop_a61839f234ddbaaf68db337e58e012499}{Criterion\+Factory}.

\begin{DoxyNote}{Note}
Dependly on the use case, some of these parameters can be {\ttfamily nullptr} as only some stopping criterion require them to be set. An example is the {\ttfamily \doxylink{classgko_1_1stop_1_1ResidualNormReduction}{Residual\+Norm\+Reduction}} which really requires the {\ttfamily initial\+\_\+residual} to be set. 
\end{DoxyNote}


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