\doxysection{gko::\+solver::\+Chebyshev\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type Struct Reference}
\hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type}{}\label{structgko_1_1solver_1_1Chebyshev_1_1parameters__type}\index{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type@{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type}}


Inheritance diagram for gko::\+solver::\+Chebyshev\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1solver_1_1Chebyshev_1_1parameters__type__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+solver::\+Chebyshev\texorpdfstring{$<$}{<} Value\+Type \texorpdfstring{$>$}{>}::\+parameters\+\_\+type:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structgko_1_1solver_1_1Chebyshev_1_1parameters__type__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_ae4e25cf7cf25f83a2c7b5fb9ad199f02}\label{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_ae4e25cf7cf25f83a2c7b5fb9ad199f02} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+foci} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
\Hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_ad340de0822b7ac7efeb588f8894d3514}\label{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_ad340de0822b7ac7efeb588f8894d3514} 
{\footnotesize template$<$typename... Args$>$ }\\auto {\bfseries with\+\_\+default\+\_\+initial\+\_\+guess} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
auto {\bfseries with\+\_\+preconditioner} (\doxymbox{\hyperlink{classgko_1_1deferred__factory__parameter}{::\+gko::\+deferred\+\_\+factory\+\_\+parameter}}$<$ preconditioner\+\_\+type $>$ factory) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\item 
auto {\bfseries with\+\_\+generated\+\_\+preconditioner} (Args \&\&... \+\_\+value) -\/$>$ std::\+decay\+\_\+t$<$ decltype(\texorpdfstring{$\ast$}{*}(this-\/$>$self()))$>$ \&
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
auto {\bfseries with\+\_\+criteria} (Args \&\&... factories) -\/$>$ 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, Factory $>$}}}
\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$<$ Factory $>$ \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::\+pair$<$ detail::\+coeff\+\_\+type$<$ value\+\_\+type $>$, detail::\+coeff\+\_\+type$<$ value\+\_\+type $>$ $>$ \doxymbox{\hyperlink{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a6820e0511be025f93cee969edf3a59ae}{foci}} \{detail::\+coeff\+\_\+type$<$value\+\_\+type$>$\{0\}, detail::\+coeff\+\_\+type$<$value\+\_\+type$>$\{1\}\}
\begin{DoxyCompactList}\small\item\em The pair of foci of ellipse, which covers the eigenvalues of preconditioned system. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}} \doxymbox{\hyperlink{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a7a41a9b17c2728165d98a87988214a6b}{default\+\_\+initial\+\_\+guess}} \{\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8aa1f5f6080965ed6d0a90e6b9ec599e441}{initial\+\_\+guess\+\_\+mode::\+provided}}\}
\begin{DoxyCompactList}\small\item\em Default initial guess mode. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+preconditioned\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOpFactory}{Lin\+Op\+Factory}} $>$ \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_abc270279ce305336c15515e385d207a1}{preconditioner}}
\begin{DoxyCompactList}\small\item\em The preconditioner to be used by the iterative solver. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__preconditioned__iterative__solver__factory__parameters_a7765c24219826716fd9be54b9a068f2e}{generated\+\_\+preconditioner}}
\begin{DoxyCompactList}\small\item\em Already generated preconditioner. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes inherited from \doxymbox{\hyperlink{structgko_1_1solver_1_1enable__iterative__solver__factory__parameters}{gko::\+solver::\+enable\+\_\+iterative\+\_\+solver\+\_\+factory\+\_\+parameters$<$ parameters\+\_\+type, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
std::\+vector$<$ std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{namespacegko_1_1stop_a61839f234ddbaaf68db337e58e012499}{stop::\+\+Criterion\+Factory}} $>$ $>$ {\bfseries criteria}
\begin{DoxyCompactList}\small\item\em Stopping criteria to be used by the solver. \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, Factory $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries factory}
\end{DoxyCompactItemize}


\label{doc-variable-members}
\Hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_doc-variable-members}
\doxysubsection{Member Data Documentation}
\Hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a7a41a9b17c2728165d98a87988214a6b}\index{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type@{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type}!default\_initial\_guess@{default\_initial\_guess}}
\index{default\_initial\_guess@{default\_initial\_guess}!gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type@{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type}}
\doxysubsubsection{\texorpdfstring{default\_initial\_guess}{default\_initial\_guess}}
{\footnotesize\ttfamily \label{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a7a41a9b17c2728165d98a87988214a6b} 
template$<$typename Value\+Type = default\+\_\+precision$>$ \\
\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}} \doxymbox{\hyperlink{classgko_1_1solver_1_1Chebyshev}{gko::\+solver::\+\+Chebyshev}}$<$ Value\+Type $>$::\+parameters\+\_\+type::\+default\+\_\+initial\+\_\+guess \{\doxymbox{\hyperlink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8aa1f5f6080965ed6d0a90e6b9ec599e441}{initial\+\_\+guess\+\_\+mode::\+provided}}\}}



Default initial guess mode. 

The available options are under \doxylink{namespacegko_1_1solver_a82d21321745fbd3dc65c276d5838bb8a}{initial\+\_\+guess\+\_\+mode}. \Hypertarget{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a6820e0511be025f93cee969edf3a59ae}\index{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type@{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type}!foci@{foci}}
\index{foci@{foci}!gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type@{gko::solver::Chebyshev$<$ ValueType $>$::parameters\_type}}
\doxysubsubsection{\texorpdfstring{foci}{foci}}
{\footnotesize\ttfamily \label{structgko_1_1solver_1_1Chebyshev_1_1parameters__type_a6820e0511be025f93cee969edf3a59ae} 
template$<$typename Value\+Type = default\+\_\+precision$>$ \\
std::\+pair$<$detail::\+coeff\+\_\+type$<$value\+\_\+type$>$, detail::\+coeff\+\_\+type$<$value\+\_\+type$>$ $>$ \doxymbox{\hyperlink{classgko_1_1solver_1_1Chebyshev}{gko::\+solver::\+\+Chebyshev}}$<$ Value\+Type $>$::\+parameters\+\_\+type::\+foci \{detail::\+coeff\+\_\+type$<$value\+\_\+type$>$\{0\}, detail::\+coeff\+\_\+type$<$value\+\_\+type$>$\{1\}\}}



The pair of foci of ellipse, which covers the eigenvalues of preconditioned system. 

It is usually a pair \{lower bound of eigval, upper bound of eigval\} of the preconditioned system if the preconditioned system only contains non-\/complex eigenvalues. The foci value must satisfy real(foci(1)) \texorpdfstring{$>$}{>}= real(foci(0)). 

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