\doxysection{gko::\+log::\+profiling\+\_\+scope\+\_\+guard Class Reference}
\hypertarget{classgko_1_1log_1_1profiling__scope__guard}{}\label{classgko_1_1log_1_1profiling__scope__guard}\index{gko::log::profiling\_scope\_guard@{gko::log::profiling\_scope\_guard}}


Scope guard that annotates its scope with the provided profiler hooks.  




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

\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892}\label{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892} 
{\bfseries profiling\+\_\+scope\+\_\+guard} ()
\begin{DoxyCompactList}\small\item\em Creates an empty (moved-\/from) scope guard. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard_af73538d396030074e0840682420433c6}{profiling\+\_\+scope\+\_\+guard}} (const char \texorpdfstring{$\ast$}{*}name, \doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27}{profile\+\_\+event\+\_\+category}} category, Profiler\+Hook::\+hook\+\_\+function begin, Profiler\+Hook::\+hook\+\_\+function end)
\begin{DoxyCompactList}\small\item\em Creates the scope guard. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_abadc621495dd5fe8ecf1c4b3d065dd87}\label{classgko_1_1log_1_1profiling__scope__guard_abadc621495dd5fe8ecf1c4b3d065dd87} 
{\bfseries \texorpdfstring{$\sim$}{\string~}profiling\+\_\+scope\+\_\+guard} ()
\begin{DoxyCompactList}\small\item\em Calls the range end function if the scope guard was not moved from. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_aac23e2cf009b989b53de9e831229ec65}\label{classgko_1_1log_1_1profiling__scope__guard_aac23e2cf009b989b53de9e831229ec65} 
{\bfseries profiling\+\_\+scope\+\_\+guard} (const profiling\+\_\+scope\+\_\+guard \&)=delete
\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_a80682f94a5845f6b73ff462142223b5a}\label{classgko_1_1log_1_1profiling__scope__guard_a80682f94a5845f6b73ff462142223b5a} 
{\bfseries profiling\+\_\+scope\+\_\+guard} (profiling\+\_\+scope\+\_\+guard \&\&other)=delete
\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_a552c1cfd064822f2a62625261bbc0463}\label{classgko_1_1log_1_1profiling__scope__guard_a552c1cfd064822f2a62625261bbc0463} 
\doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892}{profiling\+\_\+scope\+\_\+guard}} \& {\bfseries operator=} (const \doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892}{profiling\+\_\+scope\+\_\+guard}} \&)=delete
\item 
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_ac33d03802d5445e6e47990907882a437}\label{classgko_1_1log_1_1profiling__scope__guard_ac33d03802d5445e6e47990907882a437} 
\doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892}{profiling\+\_\+scope\+\_\+guard}} \& {\bfseries operator=} (\doxymbox{\hyperlink{classgko_1_1log_1_1profiling__scope__guard_a9190823839cda2bcc8c3c7bcdb749892}{profiling\+\_\+scope\+\_\+guard}} \&\&)=delete
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Scope guard that annotates its scope with the provided profiler hooks. 

\label{doc-constructors}
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classgko_1_1log_1_1profiling__scope__guard_af73538d396030074e0840682420433c6}\index{gko::log::profiling\_scope\_guard@{gko::log::profiling\_scope\_guard}!profiling\_scope\_guard@{profiling\_scope\_guard}}
\index{profiling\_scope\_guard@{profiling\_scope\_guard}!gko::log::profiling\_scope\_guard@{gko::log::profiling\_scope\_guard}}
\doxysubsubsection{\texorpdfstring{profiling\_scope\_guard()}{profiling\_scope\_guard()}}
{\footnotesize\ttfamily \label{classgko_1_1log_1_1profiling__scope__guard_af73538d396030074e0840682420433c6} 
gko::\+log::\+profiling\+\_\+scope\+\_\+guard::\+profiling\+\_\+scope\+\_\+guard (\begin{DoxyParamCaption}\item[{const char \texorpdfstring{$\ast$}{*}}]{name}{, }\item[{\doxymbox{\hyperlink{namespacegko_1_1log_a15f71654c6c4f4defc95f9359343fa27}{profile\+\_\+event\+\_\+category}}}]{category}{, }\item[{Profiler\+Hook::\+hook\+\_\+function}]{begin}{, }\item[{Profiler\+Hook::\+hook\+\_\+function}]{end}{}\end{DoxyParamCaption})}



Creates the scope guard. 


\begin{DoxyParams}{Parameters}
{\em name} & the name of the profiler range \\
\hline
{\em category} & the category of the profiler range \\
\hline
{\em begin} & the hook function to begin a range \\
\hline
{\em end} & the hook function to end a range \\
\hline
\end{DoxyParams}


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