\doxysection{gko::\+log::\+Profiler\+Hook::\+Table\+Summary\+Writer Class Reference}
\hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter}{}\label{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter}\index{gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}}


Writes the results from \doxylink{classgko_1_1log_1_1ProfilerHook_a4481de881ef88f20f47b10acddabc26c}{Profiler\+Hook::\+create\+\_\+summary()} and \doxylink{classgko_1_1log_1_1ProfilerHook_a50b6ed6bb3b179a682a95064c471ad73}{Profiler\+Hook::\+create\+\_\+nested\+\_\+summary()} to a ASCII table in Markdown format.  




{\ttfamily \+\#include $<$ginkgo/\+core/\+log/\+profiler\+\_\+hook.\+hpp$>$}



Inheritance diagram for gko::\+log::\+Profiler\+Hook::\+Table\+Summary\+Writer:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=330pt]{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+log::\+Profiler\+Hook::\+Table\+Summary\+Writer:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=330pt]{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a1f7ed4f8768af858197d633a7e634f04}{Table\+Summary\+Writer}} (std::\+ostream \&output=std::\+cerr, std::\+string header="{}Runtime summary"{})
\begin{DoxyCompactList}\small\item\em Constructs a writer on an output stream. \end{DoxyCompactList}\item 
void \doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a2f2a866829b190a4866c873fe9f1d4af}{write}} (const std::\+vector$<$ \doxymbox{\hyperlink{structgko_1_1log_1_1ProfilerHook_1_1summary__entry}{summary\+\_\+entry}} $>$ \&entries, std::\+chrono::\+nanoseconds overhead) override
\begin{DoxyCompactList}\small\item\em Callback to write out the summary results. \end{DoxyCompactList}\item 
void \doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a983a06c472660155ce7edc1cdfbbceda}{write\+\_\+nested}} (const \doxymbox{\hyperlink{structgko_1_1log_1_1ProfilerHook_1_1nested__summary__entry}{nested\+\_\+summary\+\_\+entry}} \&root, std::\+chrono::\+nanoseconds overhead) override
\begin{DoxyCompactList}\small\item\em Callback to write out the summary results. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Writes the results from \doxylink{classgko_1_1log_1_1ProfilerHook_a4481de881ef88f20f47b10acddabc26c}{Profiler\+Hook::\+create\+\_\+summary()} and \doxylink{classgko_1_1log_1_1ProfilerHook_a50b6ed6bb3b179a682a95064c471ad73}{Profiler\+Hook::\+create\+\_\+nested\+\_\+summary()} to a ASCII table in Markdown format. 

\label{doc-constructors}
\Hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a1f7ed4f8768af858197d633a7e634f04}\index{gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}!TableSummaryWriter@{TableSummaryWriter}}
\index{TableSummaryWriter@{TableSummaryWriter}!gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}}
\doxysubsubsection{\texorpdfstring{TableSummaryWriter()}{TableSummaryWriter()}}
{\footnotesize\ttfamily \label{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a1f7ed4f8768af858197d633a7e634f04} 
gko::\+log::\+\+Profiler\+Hook::\+\+Table\+Summary\+Writer::\+\+Table\+Summary\+Writer (\begin{DoxyParamCaption}\item[{std::\+ostream \&}]{output}{ = {\ttfamily std:\+:\+cerr}, }\item[{std::\+string}]{header}{ = {\ttfamily "{}Runtime~summary"{}}}\end{DoxyParamCaption})}



Constructs a writer on an output stream. 


\begin{DoxyParams}{Parameters}
{\em output} & the output stream to write the table to. \\
\hline
{\em header} & the header to write above the table. \\
\hline
\end{DoxyParams}


\label{doc-func-members}
\Hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a2f2a866829b190a4866c873fe9f1d4af}\index{gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}!write@{write}}
\index{write@{write}!gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}}
\doxysubsubsection{\texorpdfstring{write()}{write()}}
{\footnotesize\ttfamily \label{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a2f2a866829b190a4866c873fe9f1d4af} 
void gko::\+log::\+\+Profiler\+Hook::\+\+Table\+Summary\+Writer::\+write (\begin{DoxyParamCaption}\item[{const std::\+vector$<$ \doxymbox{\hyperlink{structgko_1_1log_1_1ProfilerHook_1_1summary__entry}{summary\+\_\+entry}} $>$ \&}]{entries}{, }\item[{std::\+chrono::\+nanoseconds}]{overhead}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}



Callback to write out the summary results. 


\begin{DoxyParams}{Parameters}
{\em entries} & the vector of ranges with runtime and count. \\
\hline
{\em overhead} & an estimate of the profiler overhead \\
\hline
\end{DoxyParams}


Implements \doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook_1_1SummaryWriter_a427ff4169c674ce517e93000fffd65b6}{gko::\+log::\+\+Profiler\+Hook::\+\+Summary\+Writer}}.

\Hypertarget{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a983a06c472660155ce7edc1cdfbbceda}\index{gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}!write\_nested@{write\_nested}}
\index{write\_nested@{write\_nested}!gko::log::ProfilerHook::TableSummaryWriter@{gko::log::ProfilerHook::TableSummaryWriter}}
\doxysubsubsection{\texorpdfstring{write\_nested()}{write\_nested()}}
{\footnotesize\ttfamily \label{classgko_1_1log_1_1ProfilerHook_1_1TableSummaryWriter_a983a06c472660155ce7edc1cdfbbceda} 
void gko::\+log::\+\+Profiler\+Hook::\+\+Table\+Summary\+Writer::\+write\+\_\+nested (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{structgko_1_1log_1_1ProfilerHook_1_1nested__summary__entry}{nested\+\_\+summary\+\_\+entry}} \&}]{root}{, }\item[{std::\+chrono::\+nanoseconds}]{overhead}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}



Callback to write out the summary results. 


\begin{DoxyParams}{Parameters}
{\em root} & the root range with runtime and count. \\
\hline
{\em overhead} & an estimate of the profiler overhead \\
\hline
\end{DoxyParams}


Implements \doxymbox{\hyperlink{classgko_1_1log_1_1ProfilerHook_1_1NestedSummaryWriter_a3f4bcc48ba9fedd51538adc74e00f3a8}{gko::\+log::\+\+Profiler\+Hook::\+\+Nested\+Summary\+Writer}}.



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