Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
gtsam::internal::TimingOutline Class Reference

#include <timing.h>

Public Member Functions

GTSAM_EXPORT const std::shared_ptr< TimingOutline > & child (size_t child, const std::string &label, const std::weak_ptr< TimingOutline > &thisPtr)
 
GTSAM_EXPORT void finishedIteration ()
 
double max () const
 max time, in seconds More...
 
double mean () const
 mean self time, in seconds More...
 
double min () const
 min time, in seconds More...
 
GTSAM_EXPORT void print (const std::string &outline="") const
 
GTSAM_EXPORT void print2 (const std::string &outline="", const double parentTotal=-1.0) const
 
double secs () const
 time taken, in seconds, including children More...
 
double self () const
 self time only, in seconds More...
 
GTSAM_EXPORT void tic ()
 
GTSAM_EXPORT size_t time () const
 time taken, including children More...
 
GTSAM_EXPORT TimingOutline (const std::string &label, size_t myId)
 Constructor. More...
 
GTSAM_EXPORT void toc ()
 
double wall () const
 wall time, in seconds More...
 

Protected Types

typedef FastMap< size_t, std::shared_ptr< TimingOutline > > ChildMap
 

Protected Member Functions

void add (size_t usecs, size_t usecsWall)
 

Protected Attributes

ChildMap children_
 subtrees More...
 
size_t id_
 
std::string label_
 
size_t lastChildOrder_
 
size_t myOrder_
 
size_t n_
 
std::weak_ptr< TimingOutlineparent_
 parent pointer More...
 
double t2_
 cache the $ \sum t_i^2 $ More...
 
size_t t_
 
size_t tIt_
 
size_t tMax_
 
size_t tMin_
 
size_t tWall_
 

Friends

GTSAM_EXPORT friend void toc (size_t id, const char *label)
 

Detailed Description

Timing Entry, arranged in a tree

Definition at line 148 of file timing.h.

Member Typedef Documentation

◆ ChildMap

Definition at line 164 of file timing.h.

Constructor & Destructor Documentation

◆ TimingOutline()

gtsam::internal::TimingOutline::TimingOutline ( const std::string &  label,
size_t  myId 
)

Constructor.

Definition at line 56 of file timing.cpp.

Member Function Documentation

◆ add()

void gtsam::internal::TimingOutline::add ( size_t  usecs,
size_t  usecsWall 
)
protected

Definition at line 46 of file timing.cpp.

◆ child()

const std::shared_ptr< TimingOutline > & gtsam::internal::TimingOutline::child ( size_t  child,
const std::string &  label,
const std::weak_ptr< TimingOutline > &  thisPtr 
)

Definition at line 153 of file timing.cpp.

◆ finishedIteration()

void gtsam::internal::TimingOutline::finishedIteration ( )

Definition at line 226 of file timing.cpp.

◆ max()

double gtsam::internal::TimingOutline::max ( ) const
inline

max time, in seconds

Definition at line 197 of file timing.h.

◆ mean()

double gtsam::internal::TimingOutline::mean ( ) const
inline

mean self time, in seconds

Definition at line 198 of file timing.h.

◆ min()

double gtsam::internal::TimingOutline::min ( ) const
inline

min time, in seconds

Definition at line 196 of file timing.h.

◆ print()

void gtsam::internal::TimingOutline::print ( const std::string &  outline = "") const

Definition at line 85 of file timing.cpp.

◆ print2()

void gtsam::internal::TimingOutline::print2 ( const std::string &  outline = "",
const double  parentTotal = -1.0 
) const

Definition at line 108 of file timing.cpp.

◆ secs()

double gtsam::internal::TimingOutline::secs ( ) const
inline

time taken, in seconds, including children

Definition at line 185 of file timing.h.

◆ self()

double gtsam::internal::TimingOutline::self ( ) const
inline

self time only, in seconds

Definition at line 194 of file timing.h.

◆ tic()

void gtsam::internal::TimingOutline::tic ( )

Definition at line 172 of file timing.cpp.

◆ time()

size_t gtsam::internal::TimingOutline::time ( ) const

time taken, including children

Definition at line 67 of file timing.cpp.

◆ toc()

void gtsam::internal::TimingOutline::toc ( )

Definition at line 191 of file timing.cpp.

◆ wall()

double gtsam::internal::TimingOutline::wall ( ) const
inline

wall time, in seconds

Definition at line 195 of file timing.h.

Friends And Related Function Documentation

◆ toc

GTSAM_EXPORT friend void toc ( size_t  id,
const char *  label 
)
friend

Definition at line 275 of file timing.cpp.

Member Data Documentation

◆ children_

ChildMap gtsam::internal::TimingOutline::children_
protected

subtrees

Definition at line 165 of file timing.h.

◆ id_

size_t gtsam::internal::TimingOutline::id_
protected

Definition at line 150 of file timing.h.

◆ label_

std::string gtsam::internal::TimingOutline::label_
protected

Definition at line 160 of file timing.h.

◆ lastChildOrder_

size_t gtsam::internal::TimingOutline::lastChildOrder_
protected

Definition at line 159 of file timing.h.

◆ myOrder_

size_t gtsam::internal::TimingOutline::myOrder_
protected

Definition at line 158 of file timing.h.

◆ n_

size_t gtsam::internal::TimingOutline::n_
protected

Definition at line 157 of file timing.h.

◆ parent_

std::weak_ptr<TimingOutline> gtsam::internal::TimingOutline::parent_
protected

parent pointer

Definition at line 163 of file timing.h.

◆ t2_

double gtsam::internal::TimingOutline::t2_
protected

cache the $ \sum t_i^2 $

Definition at line 153 of file timing.h.

◆ t_

size_t gtsam::internal::TimingOutline::t_
protected

Definition at line 151 of file timing.h.

◆ tIt_

size_t gtsam::internal::TimingOutline::tIt_
protected

Definition at line 154 of file timing.h.

◆ tMax_

size_t gtsam::internal::TimingOutline::tMax_
protected

Definition at line 155 of file timing.h.

◆ tMin_

size_t gtsam::internal::TimingOutline::tMin_
protected

Definition at line 156 of file timing.h.

◆ tWall_

size_t gtsam::internal::TimingOutline::tWall_
protected

Definition at line 152 of file timing.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:15