\doxysection{gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters\texorpdfstring{$<$}{<} Parameters, Factory \texorpdfstring{$>$}{>} Struct Template Reference}
\hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}\index{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}}


Inheritance diagram for gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters\texorpdfstring{$<$}{<} Parameters, Factory \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters\texorpdfstring{$<$}{<} Parameters, Factory \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_acb5e4bd40c5f5ddfa91644c9fa598cac}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_acb5e4bd40c5f5ddfa91644c9fa598cac} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+max\+\_\+iterations} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a3346eb8f11ca0dad3455610b002141df}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a3346eb8f11ca0dad3455610b002141df} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+tolerance} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a6a60380b43348f39c6b2661d3ff07b6e}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a6a60380b43348f39c6b2661d3ff07b6e} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+tolerance\+\_\+type} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a21e83ede2c24b8a7b8ec3b66d9224101}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a21e83ede2c24b8a7b8ec3b66d9224101} 
auto {\bfseries with\+\_\+preconditioner} (\doxymbox{\hyperlink{classgko_1_1deferred__factory__parameter}{::\+gko::\+deferred\+\_\+factory\+\_\+parameter}}$<$ preconditioner\+\_\+type $>$ factory) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a7ed325b7ec972b5e59697b7337d72d60}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a7ed325b7ec972b5e59697b7337d72d60} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+generated\+\_\+preconditioner} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1enable__parameters__type}{gko::\+enable\+\_\+parameters\+\_\+type$<$ Parameters, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
Parameters \& {\bfseries with\+\_\+loggers} (Args \&\&... \+\_\+value)
\begin{DoxyCompactList}\small\item\em Provides the loggers to be added to the factory and its generated objects in a fluent interface. \end{DoxyCompactList}\item 
std::\+unique\+\_\+ptr$<$ Factory $>$ \doxymbox{\hyperlink{classgko_1_1enable__parameters__type_a65a5adc4eb7078475d26e7991efae64d}{on}} (std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1Executor}{Executor}} $>$ exec) const
\begin{DoxyCompactList}\small\item\em Creates a new factory on the specified executor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
int \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a27570adff31e3558786aced9c2a0042c}{max\+\_\+iterations}} \{100\}
\begin{DoxyCompactList}\small\item\em Default maximum number iterations allowed. \end{DoxyCompactList}\item 
double \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a2de5472d843daeead2e2be40963d1e51}{tolerance}} \{1e-\/11\}
\begin{DoxyCompactList}\small\item\em Default residual tolerance. \end{DoxyCompactList}\item 
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a69d47d944c4173d4a067613a30338c0e}\label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a69d47d944c4173d4a067613a30338c0e} 
::\+gko::\+batch::\+stop::\+tolerance\+\_\+type {\bfseries tolerance\+\_\+type} \{::\+gko::\+batch::\+stop::\+tolerance\+\_\+type::\+absolute\}
\begin{DoxyCompactList}\small\item\em To specify which type of tolerance check is to be considered, absolute or relative (to the rhs l2 norm). \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOpFactory}{Batch\+Lin\+Op\+Factory}} $>$ \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a62d982e1f1bad507ea74ba0be81d859b}{preconditioner}} \{\}
\begin{DoxyCompactList}\small\item\em The preconditioner to be used by the iterative solver. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}} $>$ \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_ab9b3bdf2d54eecbfb9c322e3e4289295}{generated\+\_\+preconditioner}} \{nullptr\}
\begin{DoxyCompactList}\small\item\em Already generated preconditioner. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Additional Inherited Members}
\doxysubsection*{Public Types inherited from \doxymbox{\hyperlink{classgko_1_1enable__parameters__type}{gko::\+enable\+\_\+parameters\+\_\+type$<$ Parameters, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries factory}
\end{DoxyCompactItemize}


\label{doc-variable-members}
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_doc-variable-members}
\doxysubsection{Member Data Documentation}
\Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_ab9b3bdf2d54eecbfb9c322e3e4289295}\index{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}!generated\_preconditioner@{generated\_preconditioner}}
\index{generated\_preconditioner@{generated\_preconditioner}!gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}}
\doxysubsubsection{\texorpdfstring{generated\_preconditioner}{generated\_preconditioner}}
{\footnotesize\ttfamily \label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_ab9b3bdf2d54eecbfb9c322e3e4289295} 
template$<$typename Parameters, typename Factory$>$ \\
std::\+shared\+\_\+ptr$<$const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}}$>$ \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters}}$<$ Parameters, Factory $>$::\+generated\+\_\+preconditioner \{nullptr\}}



Already generated preconditioner. 

If one is provided, the factory {\ttfamily \doxylink{namespacegko_1_1preconditioner}{preconditioner}} will be ignored. \Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a27570adff31e3558786aced9c2a0042c}\index{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}!max\_iterations@{max\_iterations}}
\index{max\_iterations@{max\_iterations}!gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}}
\doxysubsubsection{\texorpdfstring{max\_iterations}{max\_iterations}}
{\footnotesize\ttfamily \label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a27570adff31e3558786aced9c2a0042c} 
template$<$typename Parameters, typename Factory$>$ \\
int \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters}}$<$ Parameters, Factory $>$::\+max\+\_\+iterations \{100\}}



Default maximum number iterations allowed. 

Generated solvers are initialized with this value for their maximum iterations. \Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a62d982e1f1bad507ea74ba0be81d859b}\index{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}!preconditioner@{preconditioner}}
\index{preconditioner@{preconditioner}!gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}}
\doxysubsubsection{\texorpdfstring{preconditioner}{preconditioner}}
{\footnotesize\ttfamily \label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a62d982e1f1bad507ea74ba0be81d859b} 
template$<$typename Parameters, typename Factory$>$ \\
std::\+shared\+\_\+ptr$<$const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOpFactory}{Batch\+Lin\+Op\+Factory}}$>$ \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters}}$<$ Parameters, Factory $>$::\+preconditioner \{\}}



The preconditioner to be used by the iterative solver. 

By default, no preconditioner is used. \Hypertarget{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a2de5472d843daeead2e2be40963d1e51}\index{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}!tolerance@{tolerance}}
\index{tolerance@{tolerance}!gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$@{gko::batch::solver::enable\_preconditioned\_iterative\_solver\_factory\_parameters$<$ Parameters, Factory $>$}}
\doxysubsubsection{\texorpdfstring{tolerance}{tolerance}}
{\footnotesize\ttfamily \label{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a2de5472d843daeead2e2be40963d1e51} 
template$<$typename Parameters, typename Factory$>$ \\
double \doxymbox{\hyperlink{structgko_1_1batch_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+batch::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters}}$<$ Parameters, Factory $>$::\+tolerance \{1e-\/11\}}



Default residual tolerance. 

Generated solvers are initialized with this value for their residual tolerance. 

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