\doxysection{gko::\+log Namespace Reference}
\hypertarget{namespacegko_1_1log}{}\label{namespacegko_1_1log}\index{gko::log@{gko::log}}


The logger namespace .  


\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Convergence}{Convergence}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1Convergence}{Convergence} is a \doxylink{classgko_1_1log_1_1Logger}{Logger} which logs data strictly from the {\ttfamily criterion\+\_\+check\+\_\+completed} event. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Logger}{Logger}}
\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Loggable}{Loggable}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1Loggable}{Loggable} class is an interface which should be implemented by classes wanting to support logging. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1EnableLogging}{Enable\+Logging}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1EnableLogging}{Enable\+Logging} is a mixin which should be inherited by any class which wants to enable logging. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Papi}{Papi}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1Papi}{Papi} is a \doxylink{classgko_1_1log_1_1Logger}{Logger} which logs every event to the PAPI software. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1PerformanceHint}{Performance\+Hint}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1PerformanceHint}{Performance\+Hint} is a \doxylink{classgko_1_1log_1_1Logger}{Logger} which analyzes the performance of the application and outputs hints for unnecessary copies and allocations. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook}{Profiler\+Hook}}
\begin{DoxyCompactList}\small\item\em This \doxylink{classgko_1_1log_1_1Logger}{Logger} can be used to annotate the execution of Ginkgo functionality with profiler-\/specific ranges. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard}{profiling\+\_\+scope\+\_\+guard}}
\begin{DoxyCompactList}\small\item\em Scope guard that annotates its scope with the provided profiler hooks. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1iteration__complete__data}{iteration\+\_\+complete\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing iteration complete related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1executor__data}{executor\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing \doxylink{classgko_1_1Executor}{Executor} related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1operation__data}{operation\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing Operator related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1polymorphic__object__data}{polymorphic\+\_\+object\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing \doxylink{classgko_1_1PolymorphicObject}{Polymorphic\+Object} related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1linop__data}{linop\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing \doxylink{classgko_1_1LinOp}{Lin\+Op} related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1linop__factory__data}{linop\+\_\+factory\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing \doxylink{classgko_1_1LinOp}{Lin\+Op} factory related data. \end{DoxyCompactList}\item 
struct \doxymbox{\hyperlink{structgko_1_1log_1_1criterion__data}{criterion\+\_\+data}}
\begin{DoxyCompactList}\small\item\em Struct representing Criterion related data. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Record}{Record}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1Record}{Record} is a \doxylink{classgko_1_1log_1_1Logger}{Logger} which logs every event to an object. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1SolverProgress}{Solver\+Progress}}
\begin{DoxyCompactList}\small\item\em This \doxylink{classgko_1_1log_1_1Logger}{Logger} outputs the value of all scalar values (and potentially vectors) stored internally by the solver after each iteration. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Stream}{Stream}}
\begin{DoxyCompactList}\small\item\em \doxylink{classgko_1_1log_1_1Stream}{Stream} is a \doxylink{classgko_1_1log_1_1Logger}{Logger} which logs every event to a stream. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum class \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27}{profile\+\_\+event\+\_\+category}} \{ \newline
\doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27acd69b4957f06cd818d7bf3d61980e291}{memory}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27af7235a61fdc3adc78d866fd8085d44db}{operation}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aa8cfde6331bd59eb2ac96f8911c4b666}{object}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aeed65d10ea0bf036636706d7c1af32e8}{linop}}
, \newline
\doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a9549dd6065d019211460c59a86dd6536}{factory}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a7cbf673200498a0d1324f4330825202a}{solver}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a4d4b370ab9b3dbca1ccdb1a5cca6a728}{criterion}}
, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aee11cbb19052e40b07aac0ca060c23ee}{user}}
, \newline
\doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27ad1efad72dc5b17dc66a46767c32fff40}{internal}}
 \}
\begin{DoxyCompactList}\small\item\em Categorization of logger events. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The logger namespace . 

The Logging namespace.

\doxylink{group__log}{Logging} 

\label{doc-enum-members}
\Hypertarget{namespacegko_1_1log_doc-enum-members}
\doxysubsection{Enumeration Type Documentation}
\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27}\index{gko::log@{gko::log}!profile\_event\_category@{profile\_event\_category}}
\index{profile\_event\_category@{profile\_event\_category}!gko::log@{gko::log}}
\doxysubsubsection{\texorpdfstring{profile\_event\_category}{profile\_event\_category}}
{\footnotesize\ttfamily \label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27} 
enum class \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27}{gko::\+log::\+profile\+\_\+event\+\_\+category}}\hspace{0.3cm}{\ttfamily [strong]}}



Categorization of logger events. 

\begin{DoxyEnumFields}[2]{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{memory@{memory}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!memory@{memory}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27acd69b4957f06cd818d7bf3d61980e291}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27acd69b4957f06cd818d7bf3d61980e291} 
memory&Memory allocation. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{operation@{operation}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!operation@{operation}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27af7235a61fdc3adc78d866fd8085d44db}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27af7235a61fdc3adc78d866fd8085d44db} 
operation&Kernel execution and data movement. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{object@{object}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!object@{object}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aa8cfde6331bd59eb2ac96f8911c4b666}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aa8cfde6331bd59eb2ac96f8911c4b666} 
object&\doxylink{classgko_1_1PolymorphicObject}{Polymorphic\+Object} events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{linop@{linop}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!linop@{linop}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aeed65d10ea0bf036636706d7c1af32e8}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aeed65d10ea0bf036636706d7c1af32e8} 
linop&\doxylink{classgko_1_1LinOp}{Lin\+Op} events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{factory@{factory}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!factory@{factory}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a9549dd6065d019211460c59a86dd6536}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a9549dd6065d019211460c59a86dd6536} 
factory&\doxylink{classgko_1_1LinOpFactory}{Lin\+Op\+Factory} events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{solver@{solver}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!solver@{solver}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a7cbf673200498a0d1324f4330825202a}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a7cbf673200498a0d1324f4330825202a} 
solver&Solver events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{criterion@{criterion}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!criterion@{criterion}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a4d4b370ab9b3dbca1ccdb1a5cca6a728}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27a4d4b370ab9b3dbca1ccdb1a5cca6a728} 
criterion&Stopping criterion events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{user@{user}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!user@{user}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aee11cbb19052e40b07aac0ca060c23ee}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27aee11cbb19052e40b07aac0ca060c23ee} 
user&User-\/defined events. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{internal@{internal}!gko::log@{gko::log}}
\index{gko::log@{gko::log}!internal@{internal}}
}\Hypertarget{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27ad1efad72dc5b17dc66a46767c32fff40}\label{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27ad1efad72dc5b17dc66a46767c32fff40} 
internal&For development use. \\
\hline

\end{DoxyEnumFields}
