\doxysection{Logging }
\hypertarget{group__log}{}\label{group__log}\index{Logging@{Logging}}


A module dedicated to the implementation and usage of the Logging in Ginkgo.  


\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item 
namespace \doxymbox{\hyperlink{namespacegko_1_1batch_1_1log}{gko::\+batch::\+log}}
\begin{DoxyCompactList}\small\item\em The logger namespace . \end{DoxyCompactList}\item 
namespace \doxymbox{\hyperlink{namespacegko_1_1log}{gko::\+log}}
\begin{DoxyCompactList}\small\item\em The logger namespace . \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \doxymbox{\hyperlink{classgko_1_1batch_1_1log_1_1BatchConvergence}{gko::\+batch::\+log::\+\+Batch\+Convergence$<$ Value\+Type $>$}}
\begin{DoxyCompactList}\small\item\em Logs the final residuals and iteration counts for a batch solver. \end{DoxyCompactList}\item 
class \doxymbox{\hyperlink{classgko_1_1log_1_1Convergence}{gko::\+log::\+\+Convergence$<$ Value\+Type $>$}}
\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_1Papi}{gko::\+log::\+\+Papi$<$ Value\+Type $>$}}
\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}{gko::\+log::\+\+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_1Stream}{gko::\+log::\+\+Stream$<$ Value\+Type $>$}}
\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}


\doxysubsection{Detailed Description}
A module dedicated to the implementation and usage of the Logging in Ginkgo. 

The \doxylink{classgko_1_1log_1_1Logger}{Logger} class represents a simple \doxylink{classgko_1_1log_1_1Logger}{Logger} object.

It comprises all masks and events internally. Every new logging event addition should be done here. The \doxylink{classgko_1_1log_1_1Logger}{Logger} class also provides a default implementation for most events which do nothing, therefore it is not an obligation to change all classes which derive from \doxylink{classgko_1_1log_1_1Logger}{Logger}, although it is good practice. The logger class is built using event masks to control which events should be logged, and which should not. 