\doxysection{gko::\+experimental::\+factorization::\+Cholesky\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type Struct Reference}
\hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{}\label{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}\index{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type@{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type}}


Inheritance diagram for gko::\+experimental::\+factorization::\+Cholesky\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=253pt]{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+experimental::\+factorization::\+Cholesky\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a2e8147c2fe5c7476076cb7d5764256dc}\label{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a2e8147c2fe5c7476076cb7d5764256dc} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+symbolic\+\_\+factorization} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_aa818261ba707e115b31405a69fee89a8}\label{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_aa818261ba707e115b31405a69fee89a8} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+skip\+\_\+sorting} (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\+\_\+type, Cholesky $>$}}}
\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$<$ Cholesky $>$ \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 
std::\+shared\+\_\+ptr$<$ const sparsity\+\_\+pattern\+\_\+type $>$ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a4404b9835073e6377135fbe170315a41}{symbolic\+\_\+factorization}} \{nullptr\}
\begin{DoxyCompactList}\small\item\em The combined sparsity pattern L + L\texorpdfstring{$^\wedge$}{\string^}H of the factors L and L\texorpdfstring{$^\wedge$}{\string^}H. \end{DoxyCompactList}\item 
bool \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_acef4f6391b43b4cd0d56fa02250edeba}{skip\+\_\+sorting}} \{false\}
\begin{DoxyCompactList}\small\item\em The {\ttfamily system\+\_\+matrix}, which will be given to this factory, must be sorted (first by row, then by column) in order for the algorithm to work. \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, Cholesky $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries factory}
\end{DoxyCompactItemize}


\label{doc-variable-members}
\Hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_doc-variable-members}
\doxysubsection{Member Data Documentation}
\Hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_acef4f6391b43b4cd0d56fa02250edeba}\index{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type@{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type}!skip\_sorting@{skip\_sorting}}
\index{skip\_sorting@{skip\_sorting}!gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type@{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type}}
\doxysubsubsection{\texorpdfstring{skip\_sorting}{skip\_sorting}}
{\footnotesize\ttfamily \label{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_acef4f6391b43b4cd0d56fa02250edeba} 
template$<$typename Value\+Type, typename Index\+Type$>$ \\
bool \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky}{gko::\+experimental::\+factorization::\+\+Cholesky}}$<$ Value\+Type, Index\+Type $>$::\+parameters\+\_\+type::\+skip\+\_\+sorting \{false\}}



The {\ttfamily system\+\_\+matrix}, which will be given to this factory, must be sorted (first by row, then by column) in order for the algorithm to work. 

If it is known that the matrix will be sorted, this parameter can be set to {\ttfamily true} to skip the sorting (therefore, shortening the runtime). However, if it is unknown or if the matrix is known to be not sorted, it must remain {\ttfamily false}, otherwise, the algorithm may produce incorrect results or crash. \Hypertarget{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a4404b9835073e6377135fbe170315a41}\index{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type@{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type}!symbolic\_factorization@{symbolic\_factorization}}
\index{symbolic\_factorization@{symbolic\_factorization}!gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type@{gko::experimental::factorization::Cholesky$<$ ValueType, IndexType $>$::parameters\_type}}
\doxysubsubsection{\texorpdfstring{symbolic\_factorization}{symbolic\_factorization}}
{\footnotesize\ttfamily \label{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a4404b9835073e6377135fbe170315a41} 
template$<$typename Value\+Type, typename Index\+Type$>$ \\
std::\+shared\+\_\+ptr$<$const sparsity\+\_\+pattern\+\_\+type$>$ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky}{gko::\+experimental::\+factorization::\+\+Cholesky}}$<$ Value\+Type, Index\+Type $>$::\+parameters\+\_\+type::\+symbolic\+\_\+factorization \{nullptr\}}



The combined sparsity pattern L + L\texorpdfstring{$^\wedge$}{\string^}H of the factors L and L\texorpdfstring{$^\wedge$}{\string^}H. 

It can be used to avoid the potentially costly symbolic factorization of the system matrix if its symbolic factorization is already known. If it is set to nullptr, the symbolic factorization will be computed. 

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