Sleipnir C++ API
Loading...
Searching...
No Matches
sleipnir::Profiler Class Reference

#include <sleipnir/autodiff/Profiler.hpp>

Public Member Functions

void StartSetup ()
 
void StopSetup ()
 
void StartSolve ()
 
void StopSolve ()
 
double SetupDuration () const
 
int SolveMeasurements () const
 
double AverageSolveDuration () const
 

Detailed Description

Records the number of profiler measurements (start/stop pairs) and the average duration between each start and stop call.

Member Function Documentation

◆ AverageSolveDuration()

double sleipnir::Profiler::AverageSolveDuration ( ) const
inline

The average solve duration in milliseconds as a double.

◆ SetupDuration()

double sleipnir::Profiler::SetupDuration ( ) const
inline

The setup duration in milliseconds as a double.

◆ SolveMeasurements()

int sleipnir::Profiler::SolveMeasurements ( ) const
inline

The number of solve measurements taken.

◆ StartSetup()

void sleipnir::Profiler::StartSetup ( )
inline

Tell the profiler to start measuring setup time.

◆ StartSolve()

void sleipnir::Profiler::StartSolve ( )
inline

Tell the profiler to start measuring solve time.

◆ StopSetup()

void sleipnir::Profiler::StopSetup ( )
inline

Tell the profiler to stop measuring setup time.

◆ StopSolve()

void sleipnir::Profiler::StopSolve ( )
inline

Tell the profiler to stop measuring solve time, increment the number of averages, and incorporate the latest measurement into the average.


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