Timing information for training and evaluation of MVA methods.

Usage:

TMVA::gConfig().SetDrawProgressBar(true);
 
TMVA::Timer timer( Nloops, "MyClassName" );
for (Int_t i=0; i<Nloops; i++) {
  ... // some code
 
  // now, print progress bar:
  timer.DrawProgressBar( i );
 
  // **OR** text output of left time (never both !)
  fLogger << " time left: " << timer.GetLeftTime( i ) << Endl;
 
}
fLogger << "MyClassName" << ": elapsed time: " << timer.GetElapsedTime()
        << Endl;

Remark: in batch mode, the progress bar is quite ugly; you may want to use the text output then

Note that by default in TMVA::Config the drawing of the progress bar is switched off. To have the progress bar visible you need to enable it by calling TMVA::gConfig().SetDrawProgressBar(true)

Definition at line 58 of file Timer.h.

Public Member Functions
	Timer (const char *prefix="", Bool_t colourfulOutput=kTRUE)
	constructor

	Timer (Int_t ncounts, const char *prefix="", Bool_t colourfulOutput=kTRUE)
	standard constructor: ncounts gives the total number of counts that the loop will iterate through.

virtual	~Timer (void)
	destructor

void	DrawProgressBar (Int_t, const TString &comment="")
	draws progress bar in color or B&W caution:

void	DrawProgressBar (TString)
	draws a string in the progress bar

void	DrawProgressBar (void)
	draws the progressbar

Double_t	ElapsedSeconds (void)
	computes elapsed tim in seconds

TString	GetElapsedTime (Bool_t Scientific=kTRUE)
	returns pretty string with elapsed time

TString	GetLeftTime (Int_t icounts)
	returns pretty string with time left

void	Init (Int_t ncounts)

virtual TClass *	IsA () const

void	Reset (void)
	resets timer

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TStopwatch
	TStopwatch ()
	Create a stopwatch and start it.

void	Continue ()
	Resume a stopped stopwatch.

Int_t	Counter () const

Double_t	CpuTime ()
	Stop the stopwatch (if it is running) and return the cputime (in seconds) passed between the start and stop events.

TClass *	IsA () const override

void	Print (Option_t *option="") const override
	Print the real and cpu time passed between the start and stop events.

Double_t	RealTime ()
	Stop the stopwatch (if it is running) and return the realtime (in seconds) passed between the start and stop events.

void	Reset ()

void	ResetCpuTime (Double_t time=0)

void	ResetRealTime (Double_t time=0)

void	Start (Bool_t reset=kTRUE)
	Start the stopwatch.

void	Stop ()
	Stop the stopwatch.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TStopwatch
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Member Functions
MsgLogger &	Log () const

TString	SecToText (Double_t, Bool_t) const
	pretty string output

Private Attributes
Bool_t	fColourfulOutput
	flag for use of colors

MsgLogger *	fLogger
	the output logger

Int_t	fNcounts
	reference number of "counts"

Bool_t	fOutputToFile

TString	fPrefix
	prefix for outputs

Int_t	fPreviousProgress

TString	fPreviousTimeEstimate

Int_t	fProgressBarStringLength

Static Private Attributes
static const TString	fgClassName = "Timer"
	used for output

static const Int_t	fgNbins = 16
	number of bins in progress bar

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TMVA/Timer.h>

Inheritance diagram for TMVA::Timer:

[legend]

Constructor & Destructor Documentation

◆ Timer() [1/2]

TMVA::Timer::Timer	(	const char *	prefix = `""`,
		Bool_t	colourfulOutput = `kTRUE`
	)

constructor

Definition at line 85 of file Timer.cxx.

◆ Timer() [2/2]

TMVA::Timer::Timer	(	Int_t	ncounts,
		const char *	prefix = `""`,
		Bool_t	colourfulOutput = `kTRUE`
	)

standard constructor: ncounts gives the total number of counts that the loop will iterate through.

At each call of the timer, the current number of counts is provided by the user, so that the timer can obtain the due time from linearly interpolating the spent time.

Definition at line 96 of file Timer.cxx.

◆ ~Timer()

TMVA::Timer::~Timer ( void )

virtual

destructor

Definition at line 112 of file Timer.cxx.

Member Function Documentation

◆ Class()

static TClass * TMVA::Timer::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMVA::Timer::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::Timer::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 99 of file Timer.h.

◆ DeclFileName()

static const char * TMVA::Timer::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 99 of file Timer.h.

◆ DrawProgressBar() [1/3]

void TMVA::Timer::DrawProgressBar	(	Int_t	icounts,
		const TString &	comment = `""`
	)

draws progress bar in color or B&W caution:

Definition at line 202 of file Timer.cxx.

◆ DrawProgressBar() [2/3]

void TMVA::Timer::DrawProgressBar ( TString theString )

draws a string in the progress bar

Definition at line 181 of file Timer.cxx.

◆ DrawProgressBar() [3/3]

void TMVA::Timer::DrawProgressBar ( void )

draws the progressbar

Definition at line 166 of file Timer.cxx.

◆ ElapsedSeconds()

Double_t TMVA::Timer::ElapsedSeconds ( void )

computes elapsed tim in seconds

Definition at line 137 of file Timer.cxx.

◆ GetElapsedTime()

TString TMVA::Timer::GetElapsedTime ( Bool_t Scientific = kTRUE )

returns pretty string with elapsed time

Definition at line 146 of file Timer.cxx.

◆ GetLeftTime()

TString TMVA::Timer::GetLeftTime ( Int_t icounts )

returns pretty string with time left

Definition at line 154 of file Timer.cxx.

◆ Init()

void TMVA::Timer::Init ( Int_t ncounts )

Definition at line 117 of file Timer.cxx.

◆ IsA()

virtual TClass * TMVA::Timer::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 99 of file Timer.h.

◆ Log()

MsgLogger & TMVA::Timer::Log ( ) const

inlineprivate

Definition at line 97 of file Timer.h.

◆ Reset()

void TMVA::Timer::Reset ( void )

resets timer

Definition at line 127 of file Timer.cxx.

◆ SecToText()

TString TMVA::Timer::SecToText	(	Double_t	seconds,
		Bool_t	Scientific
	)		const

private

pretty string output

Definition at line 262 of file Timer.cxx.

◆ Streamer()

virtual void TMVA::Timer::Streamer ( TBuffer & R__b )

virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMVA::Timer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 99 of file Timer.h.

Member Data Documentation

◆ fColourfulOutput

Bool_t TMVA::Timer::fColourfulOutput

private

flag for use of colors

Definition at line 84 of file Timer.h.

◆ fgClassName

const TString TMVA::Timer::fgClassName = "Timer"

staticprivate

used for output

Definition at line 93 of file Timer.h.

◆ fgNbins

const Int_t TMVA::Timer::fgNbins = 16

staticprivate

number of bins in progress bar

Definition at line 94 of file Timer.h.

◆ fLogger

MsgLogger* TMVA::Timer::fLogger

mutableprivate

the output logger

Definition at line 96 of file Timer.h.

◆ fNcounts

Int_t TMVA::Timer::fNcounts

private

reference number of "counts"

Definition at line 82 of file Timer.h.

◆ fOutputToFile

Bool_t TMVA::Timer::fOutputToFile

private

Definition at line 89 of file Timer.h.

◆ fPrefix

TString TMVA::Timer::fPrefix

private

prefix for outputs

Definition at line 83 of file Timer.h.

◆ fPreviousProgress

Int_t TMVA::Timer::fPreviousProgress

private

Definition at line 87 of file Timer.h.

◆ fPreviousTimeEstimate

TString TMVA::Timer::fPreviousTimeEstimate

private

Definition at line 88 of file Timer.h.

◆ fProgressBarStringLength

Int_t TMVA::Timer::fProgressBarStringLength

private

Definition at line 91 of file Timer.h.

Libraries for TMVA::Timer:

[legend]

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

tmva/tmva/inc/TMVA/Timer.h
tmva/tmva/src/Timer.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Timer() [1/2]

◆ Timer() [2/2]

◆ ~Timer()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ DrawProgressBar() [1/3]

◆ DrawProgressBar() [2/3]

◆ DrawProgressBar() [3/3]

◆ ElapsedSeconds()

◆ GetElapsedTime()

◆ GetLeftTime()

◆ Init()

◆ IsA()

◆ Log()

◆ Reset()

◆ SecToText()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fColourfulOutput

◆ fgClassName

◆ fgNbins

◆ fLogger

◆ fNcounts

◆ fOutputToFile

◆ fPrefix

◆ fPreviousProgress

◆ fPreviousTimeEstimate

◆ fProgressBarStringLength