\doxysection{gko::\+batch::\+solver::\+Batch\+Solver Class Reference}
\hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver}{}\label{classgko_1_1batch_1_1solver_1_1BatchSolver}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}


The \doxylink{classgko_1_1batch_1_1solver_1_1BatchSolver}{Batch\+Solver} is a base class for all batched solvers and provides the common getters and setter for these batched solver classes.  




{\ttfamily \+\#include $<$ginkgo/\+core/\+solver/\+batch\+\_\+solver\+\_\+base.\+hpp$>$}



Inheritance diagram for gko::\+batch::\+solver::\+Batch\+Solver:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1batch_1_1solver_1_1BatchSolver__inherit__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a11ba46b13df4ad9e12f2409ac6e572f7}{get\+\_\+system\+\_\+matrix}} () const
\begin{DoxyCompactList}\small\item\em Returns the system operator (matrix) of the linear system. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_ac7c6859c7a6f08cb95048d56686f7e2d}{get\+\_\+preconditioner}} () const
\begin{DoxyCompactList}\small\item\em Returns the generated preconditioner. \end{DoxyCompactList}\item 
double \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a419415d18e6b01226cddc621b84d5976}{get\+\_\+tolerance}} () const
\begin{DoxyCompactList}\small\item\em Get the residual tolerance used by the solver. \end{DoxyCompactList}\item 
void \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a57d2436e61f5ced92f8c367a15baf0c7}{reset\+\_\+tolerance}} (double res\+\_\+tol)
\begin{DoxyCompactList}\small\item\em Update the residual tolerance to be used by the solver. \end{DoxyCompactList}\item 
int \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a4d0421d8f569772dc0637932907dcb07}{get\+\_\+max\+\_\+iterations}} () const
\begin{DoxyCompactList}\small\item\em Get the maximum number of iterations set on the solver. \end{DoxyCompactList}\item 
void \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a3d3bfb23cf2fc3b1aee8e9aad2a4e488}{reset\+\_\+max\+\_\+iterations}} (int max\+\_\+iterations)
\begin{DoxyCompactList}\small\item\em Set the maximum number of iterations for the solver to use, independent of the factory that created it. \end{DoxyCompactList}\item 
::\+gko::\+batch::\+stop::\+tolerance\+\_\+type \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_a79f23896ce9872932b3848524eae4ee8}{get\+\_\+tolerance\+\_\+type}} () const
\begin{DoxyCompactList}\small\item\em Get the tolerance type. \end{DoxyCompactList}\item 
void \doxymbox{\hyperlink{classgko_1_1batch_1_1solver_1_1BatchSolver_aae3b41a8e4e43d275f62a98610ec333b}{reset\+\_\+tolerance\+\_\+type}} (::\+gko::\+batch::\+stop::\+tolerance\+\_\+type tol\+\_\+type)
\begin{DoxyCompactList}\small\item\em Set the type of tolerance check to use inside the solver. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The \doxylink{classgko_1_1batch_1_1solver_1_1BatchSolver}{Batch\+Solver} is a base class for all batched solvers and provides the common getters and setter for these batched solver classes. 

\label{doc-func-members}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a4d0421d8f569772dc0637932907dcb07}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!get\_max\_iterations@{get\_max\_iterations}}
\index{get\_max\_iterations@{get\_max\_iterations}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{get\_max\_iterations()}{get\_max\_iterations()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a4d0421d8f569772dc0637932907dcb07} 
int gko::\+batch::\+solver::\+\+Batch\+Solver::\+get\+\_\+max\+\_\+iterations (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the maximum number of iterations set on the solver. 

\begin{DoxyReturn}{Returns}
Maximum number of iterations. 
\end{DoxyReturn}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_ac7c6859c7a6f08cb95048d56686f7e2d}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!get\_preconditioner@{get\_preconditioner}}
\index{get\_preconditioner@{get\_preconditioner}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{get\_preconditioner()}{get\_preconditioner()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_ac7c6859c7a6f08cb95048d56686f7e2d} 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}} $>$ gko::\+batch::\+solver::\+\+Batch\+Solver::\+get\+\_\+preconditioner (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the generated preconditioner. 

\begin{DoxyReturn}{Returns}
the generated preconditioner. 
\end{DoxyReturn}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a11ba46b13df4ad9e12f2409ac6e572f7}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!get\_system\_matrix@{get\_system\_matrix}}
\index{get\_system\_matrix@{get\_system\_matrix}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{get\_system\_matrix()}{get\_system\_matrix()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a11ba46b13df4ad9e12f2409ac6e572f7} 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp}{Batch\+Lin\+Op}} $>$ gko::\+batch::\+solver::\+\+Batch\+Solver::\+get\+\_\+system\+\_\+matrix (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the system operator (matrix) of the linear system. 

\begin{DoxyReturn}{Returns}
the system operator (matrix) 
\end{DoxyReturn}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a419415d18e6b01226cddc621b84d5976}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!get\_tolerance@{get\_tolerance}}
\index{get\_tolerance@{get\_tolerance}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{get\_tolerance()}{get\_tolerance()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a419415d18e6b01226cddc621b84d5976} 
double gko::\+batch::\+solver::\+\+Batch\+Solver::\+get\+\_\+tolerance (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the residual tolerance used by the solver. 

\begin{DoxyReturn}{Returns}
The residual tolerance. 
\end{DoxyReturn}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a79f23896ce9872932b3848524eae4ee8}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!get\_tolerance\_type@{get\_tolerance\_type}}
\index{get\_tolerance\_type@{get\_tolerance\_type}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{get\_tolerance\_type()}{get\_tolerance\_type()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a79f23896ce9872932b3848524eae4ee8} 
::\+gko::\+batch::\+stop::\+tolerance\+\_\+type gko::\+batch::\+solver::\+\+Batch\+Solver::\+get\+\_\+tolerance\+\_\+type (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the tolerance type. 

\begin{DoxyReturn}{Returns}
The tolerance type. 
\end{DoxyReturn}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a3d3bfb23cf2fc3b1aee8e9aad2a4e488}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!reset\_max\_iterations@{reset\_max\_iterations}}
\index{reset\_max\_iterations@{reset\_max\_iterations}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{reset\_max\_iterations()}{reset\_max\_iterations()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a3d3bfb23cf2fc3b1aee8e9aad2a4e488} 
void gko::\+batch::\+solver::\+\+Batch\+Solver::\+reset\+\_\+max\+\_\+iterations (\begin{DoxyParamCaption}\item[{int}]{max\+\_\+iterations}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the maximum number of iterations for the solver to use, independent of the factory that created it. 


\begin{DoxyParams}{Parameters}
{\em max\+\_\+iterations} & The maximum number of iterations for the solver. \\
\hline
\end{DoxyParams}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_a57d2436e61f5ced92f8c367a15baf0c7}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!reset\_tolerance@{reset\_tolerance}}
\index{reset\_tolerance@{reset\_tolerance}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{reset\_tolerance()}{reset\_tolerance()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_a57d2436e61f5ced92f8c367a15baf0c7} 
void gko::\+batch::\+solver::\+\+Batch\+Solver::\+reset\+\_\+tolerance (\begin{DoxyParamCaption}\item[{double}]{res\+\_\+tol}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Update the residual tolerance to be used by the solver. 


\begin{DoxyParams}{Parameters}
{\em res\+\_\+tol} & The residual tolerance to be used for subsequent invocations of the solver. \\
\hline
\end{DoxyParams}
\Hypertarget{classgko_1_1batch_1_1solver_1_1BatchSolver_aae3b41a8e4e43d275f62a98610ec333b}\index{gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}!reset\_tolerance\_type@{reset\_tolerance\_type}}
\index{reset\_tolerance\_type@{reset\_tolerance\_type}!gko::batch::solver::BatchSolver@{gko::batch::solver::BatchSolver}}
\doxysubsubsection{\texorpdfstring{reset\_tolerance\_type()}{reset\_tolerance\_type()}}
{\footnotesize\ttfamily \label{classgko_1_1batch_1_1solver_1_1BatchSolver_aae3b41a8e4e43d275f62a98610ec333b} 
void gko::\+batch::\+solver::\+\+Batch\+Solver::\+reset\+\_\+tolerance\+\_\+type (\begin{DoxyParamCaption}\item[{::\+gko::\+batch::\+stop::\+tolerance\+\_\+type}]{tol\+\_\+type}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the type of tolerance check to use inside the solver. 


\begin{DoxyParams}{Parameters}
{\em tol\+\_\+type} & The tolerance type. \\
\hline
\end{DoxyParams}


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