\doxysection{gko::\+Use\+Composition\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>} Class Template Reference}
\hypertarget{classgko_1_1UseComposition}{}\label{classgko_1_1UseComposition}\index{gko::UseComposition$<$ ValueType $>$@{gko::UseComposition$<$ ValueType $>$}}


The \doxylink{classgko_1_1UseComposition}{Use\+Composition} class can be used to store the composition information in \doxylink{classgko_1_1LinOp}{Lin\+Op}.  




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



Inheritance diagram for gko::\+Use\+Composition\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1UseComposition__inherit__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1UseComposition_a0c12fdd9ebc794226fad8301bae83b36}\label{classgko_1_1UseComposition_a0c12fdd9ebc794226fad8301bae83b36} 
using {\bfseries value\+\_\+type} = Value\+Type
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1Composition}{Composition}}$<$ Value\+Type $>$ $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition_a81d7f1c982c43df853ed9b9074e45409}{get\+\_\+composition}} () const
\begin{DoxyCompactList}\small\item\em Returns the composition operators. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition_a46d5ea836edce6f0c0738d0218dd394b}{get\+\_\+operator\+\_\+at}} (\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} index) const
\begin{DoxyCompactList}\small\item\em Returns the operator at index-\/th position of composition. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename Value\+Type = default\+\_\+precision$>$\newline
class gko::\+\+Use\+Composition$<$ Value\+Type $>$}
The \doxylink{classgko_1_1UseComposition}{Use\+Composition} class can be used to store the composition information in \doxylink{classgko_1_1LinOp}{Lin\+Op}. 


\begin{DoxyTemplParams}{Template Parameters}
{\em Value\+Type} & precision of input and result vectors \\
\hline
\end{DoxyTemplParams}


\label{doc-func-members}
\Hypertarget{classgko_1_1UseComposition_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1UseComposition_a81d7f1c982c43df853ed9b9074e45409}\index{gko::UseComposition$<$ ValueType $>$@{gko::UseComposition$<$ ValueType $>$}!get\_composition@{get\_composition}}
\index{get\_composition@{get\_composition}!gko::UseComposition$<$ ValueType $>$@{gko::UseComposition$<$ ValueType $>$}}
\doxysubsubsection{\texorpdfstring{get\_composition()}{get\_composition()}}
{\footnotesize\ttfamily \label{classgko_1_1UseComposition_a81d7f1c982c43df853ed9b9074e45409} 
template$<$typename Value\+Type = default\+\_\+precision$>$ \\
std::\+shared\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1Composition}{Composition}}$<$ Value\+Type $>$ $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition}{gko::\+\+Use\+Composition}}$<$ Value\+Type $>$::\+get\+\_\+composition (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the composition operators. 

\begin{DoxyReturn}{Returns}
composition 
\end{DoxyReturn}
\Hypertarget{classgko_1_1UseComposition_a46d5ea836edce6f0c0738d0218dd394b}\index{gko::UseComposition$<$ ValueType $>$@{gko::UseComposition$<$ ValueType $>$}!get\_operator\_at@{get\_operator\_at}}
\index{get\_operator\_at@{get\_operator\_at}!gko::UseComposition$<$ ValueType $>$@{gko::UseComposition$<$ ValueType $>$}}
\doxysubsubsection{\texorpdfstring{get\_operator\_at()}{get\_operator\_at()}}
{\footnotesize\ttfamily \label{classgko_1_1UseComposition_a46d5ea836edce6f0c0738d0218dd394b} 
template$<$typename Value\+Type = default\+\_\+precision$>$ \\
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition}{gko::\+\+Use\+Composition}}$<$ Value\+Type $>$::\+get\+\_\+operator\+\_\+at (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}}}]{index}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the operator at index-\/th position of composition. 

\begin{DoxyReturn}{Returns}
index-\/th operator
\end{DoxyReturn}
\begin{DoxyNote}{Note}
when this composition is not set, this function always returns nullptr. However, when this composition is set, it will throw exception when exceeding index.
\end{DoxyNote}

\begin{DoxyExceptions}{Exceptions}
{\em std::\+out\+\_\+of\+\_\+range} & if index is out of bound when composition is existed. \\
\hline
\end{DoxyExceptions}


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