Sleipnir C++ API
Loading...
Searching...
No Matches
slp::SetupTimeTracer Class Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/util/time_tracer.hpp>

Public Member Functions

 SetupTimeTracer ()=default
 Constructs an enabled tracer.
 
 SetupTimeTracer (bool enabled)
 
void start ()
 Starts setup time measurement.
 
void stop ()
 Stops setup time measurement.
 
const std::chrono::duration< double > & duration () const
 

Detailed Description

Records the duration between the most recent start and stop call.

Unlike SolveTimeTracer, this doesn't count measurements or average them, so it's meant for steps that run once, like autodiff setup.

Constructor & Destructor Documentation

◆ SetupTimeTracer()

slp::SetupTimeTracer::SetupTimeTracer ( bool  enabled)
inlineexplicit

Constructs a tracer.

Parameters
enabledWhether to measure time.

Member Function Documentation

◆ duration()

const std::chrono::duration< double > & slp::SetupTimeTracer::duration ( ) const
inline

Returns the setup duration in seconds.

Returns
The setup duration in seconds.

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