StatClass Class Reference

#include <MetricUtils.h>

Collaboration diagram for StatClass:

Public Member Functions
	StatClass ()
void	ClearStats ()
int	IncNumCollDetCalls (const std::string &_cdName, const std::string &_callName)
size_t	GetIsCollTotal ()
void	IncCfgIsColl (const std::string &_callName)
int	IncLPConnections (const std::string &_lpName, int _incr=1)
int	IncLPAttempts (const std::string &_lpName, int _incr=1)
int	IncLPCollDetCalls (const std::string &_lpName, int _incr=1)
void	IncNodesGenerated (const std::string &_samplerName, size_t _incr=1)
void	IncNodesAttempted (const std::string &_samplerName, size_t _incr=1)
void	ClearClock (const std::string &_name)
void	StartClock (const std::string &_name)
void	StopClock (const std::string &_name)
void	StopPrintClock (const std::string &_name, std::ostream &_os)
void	PrintClock (const std::string &_name, std::ostream &_os)
double	GetSeconds (const std::string &_name)
int	GetUSeconds (const std::string &_name)
double	GetStat (const std::string &_s)
void	SetStat (const std::string &_s, const double _v)
void	IncStat (const std::string &_s, const double _v=1)
Average< double > &	GetAverage (const std::string &_s)
std::vector< double > &	GetHistory (const std::string &_s)
void	AddToHistory (const std::string &_s, double _v)
void	WriteHistory (const std::string &_s)
void	SetAuxDest (const std::string &_s)
void	PrintAllStats (std::ostream &_os)
template<typename RoadmapType >
void	PrintAllStats (std::ostream &_os, RoadmapType *_rmap=nullptr)
template<class GraphType >
void	DisplayCCStats (std::ostream &_os, GraphType &)

Data Fields
std::map< std::string, std::tuple< size_t, size_t, size_t > >	m_lpInfo
std::map< std::string, size_t >	m_collDetCountByName
std::map< std::string, ClockClass >	m_clockMap
std::map< std::string, size_t >	m_isCollByName
size_t	m_isCollTotal
std::map< std::string, std::pair< size_t, size_t > >	m_samplerInfo

Detailed Description

The StatClass is a storage hub of all statistics to be tracked in PMPL, including but not limited to timing, success/fail attempts, collision detection calls.

Constructor & Destructor Documentation

StatClass()

StatClass::StatClass

(

)

Member Function Documentation

AddToHistory()

void StatClass::AddToHistory	(	const std::string &	_s,
		double	_v
	)

ClearClock()

void StatClass::ClearClock

(

const std::string &

_name

)

ClearStats()

void StatClass::ClearStats

(

)

DisplayCCStats()

template<class GraphType >

void StatClass::DisplayCCStats	(	std::ostream &	_os,
		GraphType &	_g
	)

GetAverage()

Average< double > & StatClass::GetAverage

(

const std::string &

_s

)

GetHistory()

std::vector< double > & StatClass::GetHistory

(

const std::string &

_s

)

GetIsCollTotal()

size_t StatClass::GetIsCollTotal

(

)

GetSeconds()

double StatClass::GetSeconds

(

const std::string &

_name

)

GetStat()

double StatClass::GetStat

(

const std::string &

_s

)

GetUSeconds()

int StatClass::GetUSeconds

(

const std::string &

_name

)

IncCfgIsColl()

void StatClass::IncCfgIsColl

(

const std::string &

_callName

)

IncLPAttempts()

int StatClass::IncLPAttempts	(	const std::string &	_lpName,
		int	_incr = 1
	)

IncLPCollDetCalls()

int StatClass::IncLPCollDetCalls	(	const std::string &	_lpName,
		int	_incr = 1
	)

IncLPConnections()

int StatClass::IncLPConnections	(	const std::string &	_lpName,
		int	_incr = 1
	)

IncNodesAttempted()

void StatClass::IncNodesAttempted	(	const std::string &	_samplerName,
		size_t	_incr = 1
	)

IncNodesGenerated()

void StatClass::IncNodesGenerated	(	const std::string &	_samplerName,
		size_t	_incr = 1
	)

IncNumCollDetCalls()

int StatClass::IncNumCollDetCalls	(	const std::string &	_cdName,
		const std::string &	_callName
	)

IncStat()

void StatClass::IncStat	(	const std::string &	_s,
		const double	_v = 1
	)

PrintAllStats() [1/2]

void StatClass::PrintAllStats

(

std::ostream &

_os

)

PrintAllStats() [2/2]

template<typename RoadmapType >

void StatClass::PrintAllStats	(	std::ostream &	_os,
		RoadmapType *	_rmap = nullptr
	)

PrintClock()

void StatClass::PrintClock	(	const std::string &	_name,
		std::ostream &	_os
	)

SetAuxDest()

void StatClass::SetAuxDest

(

const std::string &

_s

)

SetStat()

void StatClass::SetStat	(	const std::string &	_s,
		const double	_v
	)

StartClock()

void StatClass::StartClock

(

const std::string &

_name

)

StopClock()

void StatClass::StopClock

(

const std::string &

_name

)

StopPrintClock()

void StatClass::StopPrintClock	(	const std::string &	_name,
		std::ostream &	_os
	)

WriteHistory()

void StatClass::WriteHistory

(

const std::string &

_s

)

Field Documentation

m_clockMap

std::map<std::string, ClockClass> StatClass::m_clockMap

m_collDetCountByName

std::map<std::string, size_t> StatClass::m_collDetCountByName

m_isCollByName

std::map<std::string, size_t> StatClass::m_isCollByName

IsColl simply counts the number of times a Cfg is tested for Collision.

See also

Cfg::isCollision

m_isCollTotal

size_t StatClass::m_isCollTotal

m_lpInfo

std::map<std::string, std::tuple<size_t, size_t, size_t> > StatClass::m_lpInfo

m_samplerInfo

std::map<std::string, std::pair<size_t, size_t> > StatClass::m_samplerInfo

---

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

• /opt/actions-runner/_work/open-ppl/open-ppl/src/Utilities/MetricUtils.h
• /opt/actions-runner/_work/open-ppl/open-ppl/src/Utilities/MetricUtils.cpp