\doxysection{gko::\+solver::\+parameters\+\_\+type Struct Reference}
\hypertarget{structgko_1_1solver_1_1parameters__type}{}\label{structgko_1_1solver_1_1parameters__type}\index{gko::solver::parameters\_type@{gko::solver::parameters\_type}}


Inheritance diagram for gko::\+solver::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1solver_1_1parameters__type__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+solver::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1solver_1_1parameters__type__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1solver_1_1parameters__type_aa11bb0e8f1c6c66bcc1d2a3090027ac6}\label{structgko_1_1solver_1_1parameters__type_aa11bb0e8f1c6c66bcc1d2a3090027ac6} 
auto {\bfseries with\+\_\+solver} (\doxymbox{\hyperlink{classgko_1_1deferred__factory__parameter}{::\+gko::\+deferred\+\_\+factory\+\_\+parameter}}$<$ solver\+\_\+type $>$ factory) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1solver_1_1parameters__type_a7c380cc64865e0fde1ecc319a8de2322}\label{structgko_1_1solver_1_1parameters__type_a7c380cc64865e0fde1ecc319a8de2322} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+generated\+\_\+solver} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1solver_1_1parameters__type_afd5c806d1478ae9054bf9dfabfc7762a}\label{structgko_1_1solver_1_1parameters__type_afd5c806d1478ae9054bf9dfabfc7762a} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+relaxation\+\_\+factor} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1solver_1_1parameters__type_a2078770a3320345fb21a62406af5537f}\label{structgko_1_1solver_1_1parameters__type_a2078770a3320345fb21a62406af5537f} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+default\+\_\+initial\+\_\+guess} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
auto {\bfseries with\+\_\+criteria} (Args \&\&... factories) -\/$>$ 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\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
parameters\+\_\+type \& {\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 
\Hypertarget{structgko_1_1solver_1_1parameters__type_ab435ae5dc85ac06cf552f839866823ea}\label{structgko_1_1solver_1_1parameters__type_ab435ae5dc85ac06cf552f839866823ea} 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOpFactory}{Lin\+Op\+Factory}} $>$ {\bfseries solver} \{\}
\begin{DoxyCompactList}\small\item\em Inner solver factory. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{structgko_1_1solver_1_1parameters__type_a57a0aa04756adc0d2335b609409ca9b2}{generated\+\_\+solver}} \{nullptr\}
\begin{DoxyCompactList}\small\item\em Already generated solver. \end{DoxyCompactList}\item 
\Hypertarget{structgko_1_1solver_1_1parameters__type_a8d0105656174e1f1934ccecc5839bd5a}\label{structgko_1_1solver_1_1parameters__type_a8d0105656174e1f1934ccecc5839bd5a} 
Value\+Type {\bfseries relaxation\+\_\+factor} \{value\+\_\+type\{1\}\}
\begin{DoxyCompactList}\small\item\em Relaxation factor for Richardson iteration. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}} \doxymbox{\hyperlink{structgko_1_1solver_1_1parameters__type_a7a56369b741490e04c129ed2f032c36a}{default\+\_\+initial\+\_\+guess}} \{\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8aa1f5f6080965ed6d0a90e6b9ec599e441}{initial\+\_\+guess\+\_\+mode::\+provided}}\}
\begin{DoxyCompactList}\small\item\em Default initial guess mode. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
std::\+vector$<$ std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{namespacegko_1_1stop_a61839f234ddbaaf68db337e58e012499}{stop::\+\+Criterion\+Factory}} $>$ $>$ {\bfseries criteria}
\begin{DoxyCompactList}\small\item\em Stopping criteria to be used by the solver. \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\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries factory}
\end{DoxyCompactItemize}


\label{doc-variable-members}
\Hypertarget{structgko_1_1solver_1_1parameters__type_doc-variable-members}
\doxysubsection{Member Data Documentation}
\Hypertarget{structgko_1_1solver_1_1parameters__type_a7a56369b741490e04c129ed2f032c36a}\index{gko::solver::parameters\_type@{gko::solver::parameters\_type}!default\_initial\_guess@{default\_initial\_guess}}
\index{default\_initial\_guess@{default\_initial\_guess}!gko::solver::parameters\_type@{gko::solver::parameters\_type}}
\doxysubsubsection{\texorpdfstring{default\_initial\_guess}{default\_initial\_guess}}
{\footnotesize\ttfamily \label{structgko_1_1solver_1_1parameters__type_a7a56369b741490e04c129ed2f032c36a} 
\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}} gko::\+solver::\+parameters\+\_\+type::\+default\+\_\+initial\+\_\+guess \{\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8aa1f5f6080965ed6d0a90e6b9ec599e441}{initial\+\_\+guess\+\_\+mode::\+provided}}\}}



Default initial guess mode. 

The available options are under \doxylink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}. \Hypertarget{structgko_1_1solver_1_1parameters__type_a57a0aa04756adc0d2335b609409ca9b2}\index{gko::solver::parameters\_type@{gko::solver::parameters\_type}!generated\_solver@{generated\_solver}}
\index{generated\_solver@{generated\_solver}!gko::solver::parameters\_type@{gko::solver::parameters\_type}}
\doxysubsubsection{\texorpdfstring{generated\_solver}{generated\_solver}}
{\footnotesize\ttfamily \label{structgko_1_1solver_1_1parameters__type_a57a0aa04756adc0d2335b609409ca9b2} 
std::\+shared\+\_\+ptr$<$const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}}$>$ gko::\+solver::\+parameters\+\_\+type::\+generated\+\_\+solver \{nullptr\}}



Already generated solver. 

If one is provided, the factory {\ttfamily \doxylink{namespacegko_1_1solver}{solver}} will be ignored. 

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