profiling_scope_guard Class Reference

profiling_scope_guard Class Reference#

Reference API: gko::log::profiling_scope_guard Class Reference
Reference API
gko::log::profiling_scope_guard Class Reference

#include <ginkgo/core/log/profiler_hook.hpp>

Public Member Functions

 profiling_scope_guard ()
 
 profiling_scope_guard (const char *name, profile_event_category category, ProfilerHook::hook_function begin, ProfilerHook::hook_function end)
 
 ~profiling_scope_guard ()
 
 profiling_scope_guard (const profiling_scope_guard &)=delete
 
 profiling_scope_guard (profiling_scope_guard &&other)=delete
 
profiling_scope_guardoperator= (const profiling_scope_guard &)=delete
 
profiling_scope_guardoperator= (profiling_scope_guard &&)=delete
 

Detailed Description

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

Constructor & Destructor Documentation

◆ profiling_scope_guard() [1/2]

gko::log::profiling_scope_guard::profiling_scope_guard ( )

Creates an empty (moved-from) scope guard.

◆ profiling_scope_guard() [2/2]

gko::log::profiling_scope_guard::profiling_scope_guard ( const char *  name,
profile_event_category  category,
ProfilerHook::hook_function  begin,
ProfilerHook::hook_function  end 
)

Creates the scope guard

Parameters
namethe name of the profiler range
categorythe category of the profiler range
beginthe hook function to begin a range
endthe hook function to end a range

◆ ~profiling_scope_guard()

gko::log::profiling_scope_guard::~profiling_scope_guard ( )

Calls the range end function if the scope guard was not moved from.


The documentation for this class was generated from the following file: