WPILibC++ 2025.1.1
Loading...
Searching...
No Matches
sleipnir::Profiler Class Reference

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/autodiff/Profiler.hpp>

Public Member Functions

void StartSetup ()
 Tell the profiler to start measuring setup time.
 
void StopSetup ()
 Tell the profiler to stop measuring setup time.
 
void StartSolve ()
 Tell the profiler to start measuring solve time.
 
void StopSolve ()
 Tell the profiler to stop measuring solve time, increment the number of averages, and incorporate the latest measurement into the average.
 
double SetupDuration () const
 The setup duration in milliseconds as a double.
 
int SolveMeasurements () const
 The number of solve measurements taken.
 
double AverageSolveDuration () const
 The average solve duration in milliseconds as a double.
 

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: