\doxysection{cholesky.\+hpp}
\hypertarget{cholesky_8hpp_source}{}\label{cholesky_8hpp_source}\index{ginkgo/core/factorization/cholesky.hpp@{ginkgo/core/factorization/cholesky.hpp}}

\begin{DoxyCode}{0}
\DoxyCodeLine{00001\ \textcolor{comment}{//\ SPDX-\/FileCopyrightText:\ 2017\ -\/\ 2025\ The\ Ginkgo\ authors}}
\DoxyCodeLine{00002\ \textcolor{comment}{//}}
\DoxyCodeLine{00003\ \textcolor{comment}{//\ SPDX-\/License-\/Identifier:\ BSD-\/3-\/Clause}}
\DoxyCodeLine{00004\ }
\DoxyCodeLine{00005\ \textcolor{preprocessor}{\#include\ <memory>}}
\DoxyCodeLine{00006\ }
\DoxyCodeLine{00007\ \textcolor{preprocessor}{\#include\ <ginkgo/core/base/composition.hpp>}}
\DoxyCodeLine{00008\ \textcolor{preprocessor}{\#include\ <ginkgo/core/base/lin\_op.hpp>}}
\DoxyCodeLine{00009\ \textcolor{preprocessor}{\#include\ <ginkgo/core/base/polymorphic\_object.hpp>}}
\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#include\ <ginkgo/core/config/config.hpp>}}
\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#include\ <ginkgo/core/config/registry.hpp>}}
\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#include\ <ginkgo/core/factorization/factorization.hpp>}}
\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ <ginkgo/core/matrix/csr.hpp>}}
\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#include\ <ginkgo/core/matrix/sparsity\_csr.hpp>}}
\DoxyCodeLine{00015\ }
\DoxyCodeLine{00016\ }
\DoxyCodeLine{00017\ \textcolor{keyword}{namespace\ }\doxymbox{\hyperlink{namespacegko}{gko}}\ \{}
\DoxyCodeLine{00018\ \textcolor{keyword}{namespace\ }experimental\ \{}
\DoxyCodeLine{00019\ \textcolor{keyword}{namespace\ }factorization\ \{}
\DoxyCodeLine{00020\ }
\DoxyCodeLine{00021\ }
\DoxyCodeLine{00034\ \textcolor{keyword}{template}\ <\textcolor{keyword}{typename}\ ValueType,\ \textcolor{keyword}{typename}\ IndexType>}
\DoxyCodeLine{00035\ \textcolor{keyword}{class\ }Cholesky}
\DoxyCodeLine{00036\ \ \ \ \ :\ \textcolor{keyword}{public}\ \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicObject}{EnablePolymorphicObject}}<Cholesky<ValueType,\ IndexType>,}
\DoxyCodeLine{00037\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LinOpFactory>,}
\DoxyCodeLine{00038\ \ \ \ \ \ \ \textcolor{keyword}{public}\ \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicAssignment}{EnablePolymorphicAssignment}}<Cholesky<ValueType,\ IndexType>>\ \{}
\DoxyCodeLine{00039\ \ \ \ \ GKO\_ASSERT\_SUPPORTED\_VALUE\_AND\_INDEX\_TYPE;}
\DoxyCodeLine{00040\ }
\DoxyCodeLine{00041\ \textcolor{keyword}{public}:}
\DoxyCodeLine{00042\ \ \ \ \ \textcolor{keyword}{struct\ }\doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}};}
\DoxyCodeLine{00043\ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keyword}{class\ }\doxymbox{\hyperlink{classgko_1_1EnablePolymorphicObject}{EnablePolymorphicObject}}<Cholesky,\ \doxymbox{\hyperlink{classgko_1_1LinOpFactory}{LinOpFactory}}>;}
\DoxyCodeLine{00044\ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keyword}{class\ }\doxymbox{\hyperlink{classgko_1_1enable__parameters__type}{enable\_parameters\_type}}<\doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}},\ Cholesky>;}
\DoxyCodeLine{00045\ }
\DoxyCodeLine{00046\ \ \ \ \ \textcolor{keyword}{using\ }value\_type\ =\ ValueType;}
\DoxyCodeLine{00047\ \ \ \ \ \textcolor{keyword}{using\ }index\_type\ =\ IndexType;}
\DoxyCodeLine{00048\ \ \ \ \ \textcolor{keyword}{using\ }matrix\_type\ =\ \doxymbox{\hyperlink{classgko_1_1matrix_1_1Csr}{matrix::Csr<value\_type,\ index\_type>}};}
\DoxyCodeLine{00049\ \ \ \ \ \textcolor{keyword}{using\ }sparsity\_pattern\_type\ =\ \doxymbox{\hyperlink{classgko_1_1matrix_1_1SparsityCsr}{matrix::SparsityCsr<value\_type,\ index\_type>}};}
\DoxyCodeLine{00050\ \ \ \ \ \textcolor{keyword}{using\ }factorization\_type\ =\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Factorization}{Factorization<value\_type,\ index\_type>}};}
\DoxyCodeLine{00051\ }
\DoxyCodeLine{00052\ \ \ \ \ \textcolor{keyword}{struct\ }\doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}}
\DoxyCodeLine{00053\ \ \ \ \ \ \ \ \ :\ \textcolor{keyword}{public}\ \doxymbox{\hyperlink{classgko_1_1enable__parameters__type}{enable\_parameters\_type}}<parameters\_type,\ Cholesky>\ \{}
\DoxyCodeLine{00060\ \ \ \ \ \ \ \ \ std::shared\_ptr<const\ sparsity\_pattern\_type>}
\DoxyCodeLine{00061\ \ \ \ \ \ \ \ \ \ \ \ \ \doxymbox{\hyperlink{group__LinOp_ga49d4c09c39f06b22bebbbfd1d8bfe450}{GKO\_FACTORY\_PARAMETER\_SCALAR}}(\doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_a4404b9835073e6377135fbe170315a41}{symbolic\_factorization}},\ \textcolor{keyword}{nullptr});}
\DoxyCodeLine{00062\ }
\DoxyCodeLine{00073\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \doxymbox{\hyperlink{group__LinOp_ga49d4c09c39f06b22bebbbfd1d8bfe450}{GKO\_FACTORY\_PARAMETER\_SCALAR}}(\doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type_acef4f6391b43b4cd0d56fa02250edeba}{skip\_sorting}},\ \textcolor{keyword}{false});}
\DoxyCodeLine{00074\ \ \ \ \ \};}
\DoxyCodeLine{00075\ }
\DoxyCodeLine{00081\ \ \ \ \ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}\&\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky_a673b216f6e0ef64a0e32371c2137eb58}{get\_parameters}}()\ \{\ \textcolor{keywordflow}{return}\ parameters\_;\ \}}
\DoxyCodeLine{00082\ }
\DoxyCodeLine{00086\ \ \ \ \ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}\&\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky_a47eec6a8b0df2077fa21a2ebcdaddbd0}{get\_parameters}}()\textcolor{keyword}{\ const\ }\{\ \textcolor{keywordflow}{return}\ parameters\_;\ \}}
\DoxyCodeLine{00087\ }
\DoxyCodeLine{00095\ \ \ \ \ std::unique\_ptr<factorization\_type>\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky_a92dadf3a40a738bf09eae57cbb445593}{generate}}(}
\DoxyCodeLine{00096\ \ \ \ \ \ \ \ \ std::shared\_ptr<const\ LinOp>\ system\_matrix)\ \textcolor{keyword}{const};}
\DoxyCodeLine{00097\ }
\DoxyCodeLine{00099\ \ \ \ \ \textcolor{keyword}{static}\ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky_a154cada7f11335b0148b946e3b6ad85f}{build}}()\ \{\ \textcolor{keywordflow}{return}\ \{\};\ \}}
\DoxyCodeLine{00100\ }
\DoxyCodeLine{00114\ \ \ \ \ \textcolor{keyword}{static}\ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}\ \doxymbox{\hyperlink{classgko_1_1experimental_1_1factorization_1_1Cholesky_ad6baadcfc30a20e2cd647a8a9502420a}{parse}}(}
\DoxyCodeLine{00115\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{classgko_1_1config_1_1pnode}{config::pnode}}\&\ config,\ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{classgko_1_1config_1_1registry}{config::registry}}\&\ context,}
\DoxyCodeLine{00116\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{classgko_1_1config_1_1type__descriptor}{config::type\_descriptor}}\&\ td\_for\_child\ =}
\DoxyCodeLine{00117\ \ \ \ \ \ \ \ \ \ \ \ \ config::make\_type\_descriptor<ValueType,\ IndexType>());}
\DoxyCodeLine{00118\ }
\DoxyCodeLine{00119\ \textcolor{keyword}{protected}:}
\DoxyCodeLine{00120\ \ \ \ \ \textcolor{keyword}{explicit}\ Cholesky(std::shared\_ptr<const\ Executor>\ exec,}
\DoxyCodeLine{00121\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \doxymbox{\hyperlink{structgko_1_1experimental_1_1factorization_1_1Cholesky_1_1parameters__type}{parameters\_type}}\&\ params\ =\ \{\});}
\DoxyCodeLine{00122\ }
\DoxyCodeLine{00123\ \ \ \ \ std::unique\_ptr<LinOp>\ generate\_impl(}
\DoxyCodeLine{00124\ \ \ \ \ \ \ \ \ std::shared\_ptr<const\ LinOp>\ system\_matrix)\ \textcolor{keyword}{const\ override};}
\DoxyCodeLine{00125\ }
\DoxyCodeLine{00126\ \textcolor{keyword}{private}:}
\DoxyCodeLine{00127\ \ \ \ \ parameters\_type\ parameters\_;}
\DoxyCodeLine{00128\ \};}
\DoxyCodeLine{00129\ }
\DoxyCodeLine{00130\ }
\DoxyCodeLine{00131\ \}\ \ \textcolor{comment}{//\ namespace\ factorization}}
\DoxyCodeLine{00132\ \}\ \ \textcolor{comment}{//\ namespace\ experimental}}
\DoxyCodeLine{00133\ \}\ \ \textcolor{comment}{//\ namespace\ gko}}

\end{DoxyCode}
