Auxiliary class. More...

#include </builds/gaudi/Gaudi/GaudiAlg/src/components/TimerForSequencer.h>

Collaboration diagram for TimerForSequencer:

Public Member Functions
	TimerForSequencer (std::string name, unsigned int size, double factor)
	Constructor. More...

	~TimerForSequencer ()=default

void	start ()
	Start a time measurement. More...

uint64_t	stop ()
	Stop time measurement and return the last elapsed time. More...

const std::string &	name () const
	returns the name More...

double	lastTime () const
	returns the last measured time More...

double	lastCpu () const
	returns the last measured time More...

double	elapsedTotal () const
	returns the total elapsed time More...

double	cpuTotal () const
	returns the toptal cpu time More...

uint64_t	count () const
	Returns the number run count. More...

MsgStream &	fillStream (MsgStream &s) const
	Write measured time into the message stream. More...

Static Public Member Functions
static std::string	header (std::string::size_type size)
	header matching the previous format More...

Private Attributes
std::string	m_name

unsigned int	m_size

double	m_factor

uint64_t	m_startClock = 0ULL

uint64_t	m_startCpu = 0ULL

uint64_t	m_num = 0ULL

uint64_t	m_lastTime = 0ULL

uint64_t	m_lastCpu = 0ULL

uint64_t	m_min = 0ULL

uint64_t	m_max = 0ULL

uint64_t	m_sum = 0ULL

uint64_t	m_sum2 = 0ULL

uint64_t	m_sumCpu = 0ULL

Detailed Description

Auxiliary class.

Measure the time between start and stop, and compute average, min and max. In fact, measure the cpu time, and the elapsed time but gives min/max only for elapsed.

Avoid usage of double precision floating point to cumulate counts and use unsigned long long integers instead. The total capacity is enough (~1.8e19) and there is no risk to loose counts when the available sum is big with respect to the added duration. The sigma

Author: O.Callot; D.Piparo

Definition at line 30 of file TimerForSequencer.h.

Constructor & Destructor Documentation

◆ TimerForSequencer()

TimerForSequencer::TimerForSequencer	(	std::string	name,
		unsigned int	size,
		double	factor
	)

inline

Constructor.

Specify the name, for later printing.

Definition at line 34 of file TimerForSequencer.h.

35 : m_name( std::move( name ) ), m_size( size ), m_factor( factor ) {}

◆ ~TimerForSequencer()

TimerForSequencer::~TimerForSequencer ( )

default

Member Function Documentation

◆ count()

uint64_t TimerForSequencer::count ( ) const

inline

Returns the number run count.

Definition at line 66 of file TimerForSequencer.h.

66 { return m_num; }

◆ cpuTotal()

double TimerForSequencer::cpuTotal ( ) const

inline

returns the toptal cpu time

Definition at line 63 of file TimerForSequencer.h.

63 { return m_sumCpu * m_factor; }

◆ elapsedTotal()

double TimerForSequencer::elapsedTotal ( ) const

inline

returns the total elapsed time

Definition at line 60 of file TimerForSequencer.h.

60 { return m_sum * m_factor; }

◆ fillStream()

MsgStream & TimerForSequencer::fillStream ( MsgStream & s ) const

Write measured time into the message stream.

Definition at line 44 of file TimerForSequencer.cpp.

                                                              {
   float ave = 0.f;
   float cpu = 0.f;
  
   if ( 0ULL != m_num ) {
     ave = m_sum / m_num;
     cpu = m_sumCpu / m_num;
   }
  
   ave *= m_factor;
   cpu *= m_factor;
   float min = m_min * m_factor;
   float max = m_max * m_factor;
   float sum = m_sum * m_factor;
  
   // Calculate the sigma with 2 momenta. ROOT histos call this quantity
   // RMS but just to be consistent with paw.
   // The division is by N-1 since one degree of freedom is used to calculate
   // the average. See your favourite book for the proof!
   float sigma = m_num <= 1ULL ? 0.f : m_factor * sqrt( ( m_sum2 - m_sum * m_sum / m_num ) / ( m_num - 1 ) );
  
   return s << m_name.substr( 0, m_size )
            << format( "| %9.3f | %9.3f | %8.3f %9.1f %8.2f | %7lu | %9.3f |", cpu, ave, min, max, sigma, m_num,
                       sum * 0.001f );
 }

◆ header()

std::string TimerForSequencer::header ( std::string::size_type size )

static

header matching the previous format

Definition at line 70 of file TimerForSequencer.cpp.

                                                              {
   return "Algorithm" + std::string( std::max( std::string::size_type( 21 ), size ) - 20, ' ' ) +
          "(millisec) |    <user> |   <clock> |" + "      min       max    sigma | entries | total (s) |";
 }

◆ lastCpu()

double TimerForSequencer::lastCpu ( ) const

inline

returns the last measured time

Definition at line 57 of file TimerForSequencer.h.

57 { return m_lastCpu * m_factor; }

◆ lastTime()

double TimerForSequencer::lastTime ( ) const

inline

returns the last measured time

Definition at line 54 of file TimerForSequencer.h.

54 { return m_lastTime * m_factor; }

◆ name()

const std::string& TimerForSequencer::name ( ) const

inline

returns the name

Definition at line 51 of file TimerForSequencer.h.

51 { return m_name; }

◆ start()

void TimerForSequencer::start ( )

inline

Start a time measurement.

Definition at line 40 of file TimerForSequencer.h.

                       {
     m_startClock = System::currentTime( System::microSec );
     m_startCpu   = System::cpuTime( System::microSec );
   }

◆ stop()

uint64_t TimerForSequencer::stop ( )

Stop time measurement and return the last elapsed time.

Returns: Measured time in ms

Definition at line 20 of file TimerForSequencer.cpp.

                                  {
   uint64_t cpuTime  = System::cpuTime( System::microSec ) - m_startCpu;
   uint64_t lastTime = System::currentTime( System::microSec ) - m_startClock;
  
   //== Update the counter
   m_num += 1ULL;
   m_sum += lastTime;
   m_sum2 += lastTime * lastTime;
   m_sumCpu += cpuTime;
  
   // Branchless update, only cast
   bool numIsFirst = ( 1ULL == m_num );
   m_min += lastTime * numIsFirst;
   m_max += lastTime * numIsFirst;
  
   m_min = lastTime < m_min ? lastTime : m_min;
   m_max = lastTime > m_max ? lastTime : m_max;
  
   m_lastTime = lastTime;
   m_lastCpu  = cpuTime;
  
   return lastTime;
 }

Member Data Documentation

◆ m_factor

double TimerForSequencer::m_factor

private

Definition at line 77 of file TimerForSequencer.h.

◆ m_lastCpu

uint64_t TimerForSequencer::m_lastCpu = 0ULL

private

Definition at line 83 of file TimerForSequencer.h.

◆ m_lastTime

uint64_t TimerForSequencer::m_lastTime = 0ULL

private

Definition at line 82 of file TimerForSequencer.h.

◆ m_max

uint64_t TimerForSequencer::m_max = 0ULL

private

Definition at line 85 of file TimerForSequencer.h.

◆ m_min

uint64_t TimerForSequencer::m_min = 0ULL

private

Definition at line 84 of file TimerForSequencer.h.

◆ m_name

std::string TimerForSequencer::m_name

private

Definition at line 75 of file TimerForSequencer.h.

◆ m_num

uint64_t TimerForSequencer::m_num = 0ULL

private

Definition at line 81 of file TimerForSequencer.h.

◆ m_size

unsigned int TimerForSequencer::m_size

private

Definition at line 76 of file TimerForSequencer.h.

◆ m_startClock

uint64_t TimerForSequencer::m_startClock = 0ULL

private

Definition at line 78 of file TimerForSequencer.h.

◆ m_startCpu

uint64_t TimerForSequencer::m_startCpu = 0ULL

private

Definition at line 79 of file TimerForSequencer.h.

◆ m_sum

uint64_t TimerForSequencer::m_sum = 0ULL

private

Definition at line 86 of file TimerForSequencer.h.

◆ m_sum2

uint64_t TimerForSequencer::m_sum2 = 0ULL

private

Definition at line 87 of file TimerForSequencer.h.

◆ m_sumCpu

uint64_t TimerForSequencer::m_sumCpu = 0ULL

private

Definition at line 88 of file TimerForSequencer.h.

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

GaudiAlg/src/components/TimerForSequencer.h
GaudiAlg/src/components/TimerForSequencer.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimerForSequencer()

◆ ~TimerForSequencer()

Member Function Documentation

◆ count()

◆ cpuTotal()

◆ elapsedTotal()

◆ fillStream()

◆ header()

◆ lastCpu()

◆ lastTime()

◆ name()

◆ start()

◆ stop()

Member Data Documentation

◆ m_factor

◆ m_lastCpu

◆ m_lastTime

◆ m_max

◆ m_min

◆ m_name

◆ m_num

◆ m_size

◆ m_startClock

◆ m_startCpu

◆ m_sum

◆ m_sum2

◆ m_sumCpu