\doxysection{gko::\+preconditioner::\+Ic\texorpdfstring{$<$}{<} LSolver\+Type\+Or\+Value\+Type, Index\+Type \texorpdfstring{$>$}{>} Class Template Reference}
\hypertarget{classgko_1_1preconditioner_1_1Ic}{}\label{classgko_1_1preconditioner_1_1Ic}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}


The Incomplete Cholesky (IC) preconditioner solves the equation $LL^H*x = b$ for a given lower triangular matrix L and the right hand side b (can contain multiple right hand sides).  




{\ttfamily \+\#include $<$ginkgo/\+core/\+preconditioner/\+ic.\+hpp$>$}



Inheritance diagram for gko::\+preconditioner::\+Ic\texorpdfstring{$<$}{<} LSolver\+Type\+Or\+Value\+Type, Index\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1preconditioner_1_1Ic__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+preconditioner::\+Ic\texorpdfstring{$<$}{<} LSolver\+Type\+Or\+Value\+Type, Index\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1preconditioner_1_1Ic__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \doxymbox{\hyperlink{structgko_1_1preconditioner_1_1Ic_1_1parameters__type}{parameters\+\_\+type}}
\item 
class \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_1_1Factory}{Factory}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
using \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a1985bc5e256c0767525c749d84fbc4da}{l\+\_\+solver\+\_\+type}}
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a6c163e3eae5247e323003daa20918442}\label{classgko_1_1preconditioner_1_1Ic_a6c163e3eae5247e323003daa20918442} 
using {\bfseries value\+\_\+type} = gko::\+detail::\+get\+\_\+value\+\_\+type$<$LSolver\+Type\+Or\+Value\+Type$>$
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a8ad789a8e6a2ee69f9f0b0895f9fd7e3}\label{classgko_1_1preconditioner_1_1Ic_a8ad789a8e6a2ee69f9f0b0895f9fd7e3} 
using {\bfseries lh\+\_\+solver\+\_\+type} = gko::\+detail::\+transposed\+\_\+type$<$l\+\_\+solver\+\_\+type$>$
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_ae7dd145e7efd85ab4ee066ae238b379b}\label{classgko_1_1preconditioner_1_1Ic_ae7dd145e7efd85ab4ee066ae238b379b} 
using {\bfseries index\+\_\+type} = Index\+Type
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a891b6fcdfc1f8579ffc96cb4d6a8c030}\label{classgko_1_1preconditioner_1_1Ic_a891b6fcdfc1f8579ffc96cb4d6a8c030} 
using {\bfseries transposed\+\_\+type} = \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}}$<$LSolver\+Type\+Or\+Value\+Type, Index\+Type$>$
\end{DoxyCompactItemize}
\doxysubsection*{Public Types inherited from \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicAssignment}{gko::\+\+Enable\+Polymorphic\+Assignment$<$ Ic$<$ solver::\+\+Lower\+Trs$<$$>$, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries result\+\_\+type}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_ad4e5b6e25e85d2f20704035b7719eea8}\label{classgko_1_1preconditioner_1_1Ic_ad4e5b6e25e85d2f20704035b7719eea8} 
const \doxymbox{\hyperlink{structgko_1_1preconditioner_1_1Ic_1_1parameters__type}{parameters\+\_\+type}} \& {\bfseries get\+\_\+parameters} () const
\item 
std::\+shared\+\_\+ptr$<$ const l\+\_\+solver\+\_\+type $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_af429c11fb22226cacce21544f4fc3b7f}{get\+\_\+l\+\_\+solver}} () const
\begin{DoxyCompactList}\small\item\em Returns the solver which is used for the provided L matrix. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const lh\+\_\+solver\+\_\+type $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a81601c95747d96f83e1f71a9523df822}{get\+\_\+lh\+\_\+solver}} () const
\begin{DoxyCompactList}\small\item\em Returns the solver which is used for the L\texorpdfstring{$^\wedge$}{\string^}H matrix. \end{DoxyCompactList}\item 
std::\+unique\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc}{transpose}} () const override
\begin{DoxyCompactList}\small\item\em Returns a \doxylink{classgko_1_1LinOp}{Lin\+Op} representing the transpose of the \doxylink{classgko_1_1Transposable}{Transposable} object. \end{DoxyCompactList}\item 
std::\+unique\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5}{conj\+\_\+transpose}} () const override
\begin{DoxyCompactList}\small\item\em Returns a \doxylink{classgko_1_1LinOp}{Lin\+Op} representing the conjugate transpose of the \doxylink{classgko_1_1Transposable}{Transposable} object. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \& \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a2bde451992151de66f7d6c15818914cb}{operator=}} (const \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \&other)
\begin{DoxyCompactList}\small\item\em Copy-\/assigns an IC preconditioner. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \& \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a375dcf8ab16c15bbb4d4a1d79d9524a1}{operator=}} (\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \&\&other)
\begin{DoxyCompactList}\small\item\em Move-\/assigns an IC preconditioner. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} (const Ic \&other)
\begin{DoxyCompactList}\small\item\em Copy-\/constructs an IC preconditioner. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a829838c89844bf6eb96a01ec17249be9}{Ic}} (Ic \&\&other)
\begin{DoxyCompactList}\small\item\em Move-\/constructs an IC preconditioner. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1EnableLinOp}{gko::\+\+Enable\+Lin\+Op$<$ Ic$<$ solver::\+\+Lower\+Trs$<$$>$, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
const Ic$<$ \doxymbox{\hyperlink{classgko_1_1solver_1_1LowerTrs}{solver::\+\+Lower\+Trs}}$<$$>$, \doxymbox{\hyperlink{namespacegko_a16bd14c10900eb804d784908d8aab5ab}{int32}} $>$ \texorpdfstring{$\ast$}{*} {\bfseries apply} (\doxymbox{\hyperlink{classgko_1_1ptr__param}{ptr\+\_\+param}}$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ b, \doxymbox{\hyperlink{classgko_1_1ptr__param}{ptr\+\_\+param}}$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ x) const
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicAssignment}{gko::\+\+Enable\+Polymorphic\+Assignment$<$ Ic$<$ solver::\+\+Lower\+Trs$<$$>$, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
void {\bfseries convert\+\_\+to} (result\+\_\+type \texorpdfstring{$\ast$}{*}result) const override
\item 
void {\bfseries move\+\_\+to} (result\+\_\+type \texorpdfstring{$\ast$}{*}result) override
\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_aec0ca6f1f0c10a50cd173aad958398cb}\label{classgko_1_1preconditioner_1_1Ic_aec0ca6f1f0c10a50cd173aad958398cb} 
static auto {\bfseries build} () -\/$>$ decltype(\doxymbox{\hyperlink{classgko_1_1EnableDefaultFactory_a1d077101d9e788e6c65f088612d14cc3}{Factory::\+create}}())
\item 
static \doxymbox{\hyperlink{structgko_1_1preconditioner_1_1Ic_1_1parameters__type}{parameters\+\_\+type}} \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a280d45df2d4caafb80b2401d65c22ff6}{parse}} (const \doxymbox{\hyperlink{classgko_1_1config_1_1pnode}{config::\+pnode}} \&config, const \doxymbox{\hyperlink{classgko_1_1config_1_1registry}{config::\+registry}} \&context, const \doxymbox{\hyperlink{classgko_1_1config_1_1type__descriptor}{config::\+type\+\_\+descriptor}} \&td\+\_\+for\+\_\+child=config::\+make\+\_\+type\+\_\+descriptor$<$ value\+\_\+type, index\+\_\+type $>$())
\begin{DoxyCompactList}\small\item\em Create the parameters from the property\+\_\+tree. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_aa1047204aff09b45cdd9d53ca8c090c1}\label{classgko_1_1preconditioner_1_1Ic_aa1047204aff09b45cdd9d53ca8c090c1} 
class {\bfseries Enable\+Lin\+Op$<$ Ic $>$}
\item 
\Hypertarget{classgko_1_1preconditioner_1_1Ic_ae6cabde52c841f22c0141b64d9ec25f3}\label{classgko_1_1preconditioner_1_1Ic_ae6cabde52c841f22c0141b64d9ec25f3} 
class {\bfseries Enable\+Polymorphic\+Object$<$ Ic, Lin\+Op $>$}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$\newline
class gko::\+preconditioner::\+\+Ic$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$}
The Incomplete Cholesky (IC) preconditioner solves the equation $LL^H*x = b$ for a given lower triangular matrix L and the right hand side b (can contain multiple right hand sides). 

It allows to set both the solver for L defaulting to \doxylink{classgko_1_1solver_1_1LowerTrs}{solver::\+\+Lower\+Trs}, which is a direct triangular solvers. The solver for L\texorpdfstring{$^\wedge$}{\string^}H is the conjugate-\/transposed solver for L, ensuring that the preconditioner is symmetric and positive-\/definite. For this L solver, a factory can be provided (using {\ttfamily with\+\_\+l\+\_\+solver}) to have more control over their behavior. In particular, it is possible to use an iterative method for solving the triangular systems. The default parameters for an iterative triangluar solver are:\+
\begin{DoxyItemize}
\item reduction factor = 1e-\/4
\item max iteration = $<$number of rows of the matrix given to the solver$>$ Solvers without such criteria can also be used, in which case none are set.
\end{DoxyItemize}

An object of this class can be created with a matrix or a \doxylink{classgko_1_1Composition}{gko::\+\+Composition} containing two matrices. If created with a matrix, it is factorized before creating the solver. If a \doxylink{classgko_1_1Composition}{gko::\+\+Composition} (containing two matrices) is used, the first operand will be taken as the L matrix, the second will be considered the L\texorpdfstring{$^\wedge$}{\string^}H matrix, which helps to avoid the otherwise necessary transposition of L inside the solver. Par\+Ic can be directly used, since it orders the factors in the correct way.

\begin{DoxyNote}{Note}
When providing a \doxylink{classgko_1_1Composition}{gko::\+\+Composition}, the first matrix must be the lower matrix ( $L$), and the second matrix must be its conjugate-\/transpose ( $L^H$). If they are swapped, solving might crash or return the wrong result.

Do not use symmetric solvers (like CG) for the L solver since both matrices (L and L\texorpdfstring{$^\wedge$}{\string^}H) are, by design, not symmetric.

This class is not thread safe (even a const object is not) because it uses an internal cache to accelerate multiple (sequential) applies. Using it in parallel can lead to segmentation faults, wrong results and other unwanted behavior.

The default template during parse is \texorpdfstring{$<$}{<}Value\+Type, Index\+Type\texorpdfstring{$>$}{>} not \texorpdfstring{$<$}{<}Lower\+Trs, Index\+Type\texorpdfstring{$>$}{>}. Only the variants with Value\+Type are supported in parse.
\end{DoxyNote}

\begin{DoxyTemplParams}{Template Parameters}
{\em LSolver\+Type\+Or\+Value\+Type} & type of the solver or the value type used for the L matrix. Defaults to \doxylink{classgko_1_1solver_1_1LowerTrs}{solver::\+\+Lower\+Trs} \\
\hline
{\em Index\+Type} & type of the indices when Par\+Ic is used to generate the L and L\texorpdfstring{$^\wedge$}{\string^}H factors. Irrelevant otherwise. \\
\hline
\end{DoxyTemplParams}


\label{doc-typedef-members}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_doc-typedef-members}
\doxysubsection{Member Typedef Documentation}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a1985bc5e256c0767525c749d84fbc4da}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!l\_solver\_type@{l\_solver\_type}}
\index{l\_solver\_type@{l\_solver\_type}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{l\_solver\_type}{l\_solver\_type}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a1985bc5e256c0767525c749d84fbc4da} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
using \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+l\+\_\+solver\+\_\+type}

{\bfseries Initial value:\+}
\begin{DoxyCode}{0}
\DoxyCodeLine{}
\DoxyCodeLine{std::conditional\_t<gko::detail::is\_ginkgo\_linop<LSolverTypeOrValueType>,}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LSolverTypeOrValueType,\ \doxymbox{\hyperlink{classgko_1_1LinOp}{LinOp}}>}

\end{DoxyCode}


\label{doc-constructors}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!Ic@{Ic}}
\index{Ic@{Ic}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{Ic()}{Ic()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+\+Ic (\begin{DoxyParamCaption}\item[{const Ic$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$ \&}]{other}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Copy-\/constructs an IC preconditioner. 

Inherits the executor, shallow-\/copies the solvers and parameters. \Hypertarget{classgko_1_1preconditioner_1_1Ic_a829838c89844bf6eb96a01ec17249be9}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!Ic@{Ic}}
\index{Ic@{Ic}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{Ic()}{Ic()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a829838c89844bf6eb96a01ec17249be9} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+\+Ic (\begin{DoxyParamCaption}\item[{Ic$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$ \&\&}]{other}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Move-\/constructs an IC preconditioner. 

Inherits the executor, moves the solvers and parameters. The moved-\/from object is empty (0x0 with nullptr solvers and default parameters) 

\label{doc-func-members}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!conj\_transpose@{conj\_transpose}}
\index{conj\_transpose@{conj\_transpose}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{conj\_transpose()}{conj\_transpose()}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
std::\+unique\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+conj\+\_\+transpose (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Returns a \doxylink{classgko_1_1LinOp}{Lin\+Op} representing the conjugate transpose of the \doxylink{classgko_1_1Transposable}{Transposable} object. 

\begin{DoxyReturn}{Returns}
a pointer to the new conjugate transposed object 
\end{DoxyReturn}


Implements \doxymbox{\hyperlink{classgko_1_1Transposable_a7c230aacdb222f09ba49baf0bd9e82eb}{gko::\+\+Transposable}}.



Referenced by \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5}{conj\+\_\+transpose()}}.

\Hypertarget{classgko_1_1preconditioner_1_1Ic_af429c11fb22226cacce21544f4fc3b7f}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!get\_l\_solver@{get\_l\_solver}}
\index{get\_l\_solver@{get\_l\_solver}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{get\_l\_solver()}{get\_l\_solver()}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_af429c11fb22226cacce21544f4fc3b7f} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
std::\+shared\+\_\+ptr$<$ const l\+\_\+solver\+\_\+type $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+get\+\_\+l\+\_\+solver (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the solver which is used for the provided L matrix. 

\begin{DoxyReturn}{Returns}
the solver which is used for the provided L matrix 
\end{DoxyReturn}


Referenced by \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5}{conj\+\_\+transpose()}}, and \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc}{transpose()}}.

\Hypertarget{classgko_1_1preconditioner_1_1Ic_a81601c95747d96f83e1f71a9523df822}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!get\_lh\_solver@{get\_lh\_solver}}
\index{get\_lh\_solver@{get\_lh\_solver}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{get\_lh\_solver()}{get\_lh\_solver()}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a81601c95747d96f83e1f71a9523df822} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
std::\+shared\+\_\+ptr$<$ const lh\+\_\+solver\+\_\+type $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+get\+\_\+lh\+\_\+solver (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the solver which is used for the L\texorpdfstring{$^\wedge$}{\string^}H matrix. 

\begin{DoxyReturn}{Returns}
the solver which is used for the L\texorpdfstring{$^\wedge$}{\string^}H matrix 
\end{DoxyReturn}


Referenced by \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a871b1f3209b309c88af7d61fdae865a5}{conj\+\_\+transpose()}}, and \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc}{transpose()}}.

\Hypertarget{classgko_1_1preconditioner_1_1Ic_a2bde451992151de66f7d6c15818914cb}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!operator=@{operator=}}
\index{operator=@{operator=}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{operator=()}{operator=()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a2bde451992151de66f7d6c15818914cb} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \& \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+operator= (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$ \&}]{other}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Copy-\/assigns an IC preconditioner. 

Preserves the executor, shallow-\/copies the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor. \Hypertarget{classgko_1_1preconditioner_1_1Ic_a375dcf8ab16c15bbb4d4a1d79d9524a1}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!operator=@{operator=}}
\index{operator=@{operator=}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{operator=()}{operator=()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a375dcf8ab16c15bbb4d4a1d79d9524a1} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}} \& \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+operator= (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_ac5aed93da8c97cfeff5364070fabec67}{Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$ \&\&}]{other}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Move-\/assigns an IC preconditioner. 

Preserves the executor, moves the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor. The moved-\/from object is empty (0x0 with nullptr solvers and default parameters) \Hypertarget{classgko_1_1preconditioner_1_1Ic_a280d45df2d4caafb80b2401d65c22ff6}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!parse@{parse}}
\index{parse@{parse}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{parse()}{parse()}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a280d45df2d4caafb80b2401d65c22ff6} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
\doxymbox{\hyperlink{structgko_1_1preconditioner_1_1Ic_1_1parameters__type}{parameters\+\_\+type}} \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+parse (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{classgko_1_1config_1_1pnode}{config::\+pnode}} \&}]{config}{, }\item[{const \doxymbox{\hyperlink{classgko_1_1config_1_1registry}{config::\+registry}} \&}]{context}{, }\item[{const \doxymbox{\hyperlink{classgko_1_1config_1_1type__descriptor}{config::\+type\+\_\+descriptor}} \&}]{td\+\_\+for\+\_\+child}{ = {\ttfamily config:\+:\+make\+\_\+type\+\_\+descriptor$<$value\+\_\+type,~index\+\_\+type$>$()}}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Create the parameters from the property\+\_\+tree. 

Because this is directly tied to the specific type, the value/\+index type settings within config are ignored and type\+\_\+descriptor is only used for children configs.


\begin{DoxyParams}{Parameters}
{\em config} & the property tree for setting \\
\hline
{\em context} & the registry \\
\hline
{\em td\+\_\+for\+\_\+child} & the type descriptor for children configs. The default uses the value/\+index type of this class. When l\+\_\+solver\+\_\+type uses \doxylink{classgko_1_1LinOp}{Lin\+Op} not concrete type, it will use the \doxylink{namespacegko_a89637c833af7ae805802226d97cebebf}{default\+\_\+precision} in ginkgo.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
parameters
\end{DoxyReturn}
\begin{DoxyNote}{Note}
only support the following when using \texorpdfstring{$<$}{<}Value\+Type, Index\+Type\texorpdfstring{$>$}{>} not \texorpdfstring{$<$}{<}LSolver\+Type, Index\+Type\texorpdfstring{$>$}{>} variants 
\end{DoxyNote}
\Hypertarget{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc}\index{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}!transpose@{transpose}}
\index{transpose@{transpose}!gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$@{gko::preconditioner::Ic$<$ LSolverTypeOrValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{transpose()}{transpose()}}
{\footnotesize\ttfamily \label{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc} 
template$<$typename LSolver\+Type\+Or\+Value\+Type = solver::\+\+Lower\+Trs$<$$>$, typename Index\+Type = int32$>$ \\
std::\+unique\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic}{gko::\+preconditioner::\+\+Ic}}$<$ LSolver\+Type\+Or\+Value\+Type, Index\+Type $>$::\+transpose (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Returns a \doxylink{classgko_1_1LinOp}{Lin\+Op} representing the transpose of the \doxylink{classgko_1_1Transposable}{Transposable} object. 

\begin{DoxyReturn}{Returns}
a pointer to the new transposed object 
\end{DoxyReturn}


Implements \doxymbox{\hyperlink{classgko_1_1Transposable_adf04fdf2ed79b117edbef42520bfe8fa}{gko::\+\+Transposable}}.



Referenced by \doxymbox{\hyperlink{classgko_1_1preconditioner_1_1Ic_a50377c364b6b4b472cd5a58d94b0aacc}{transpose()}}.



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