Logo ROOT   6.14/05
Reference Guide
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TBenchmark Class Reference

This class is a ROOT utility to help benchmarking applications.

Definition at line 29 of file TBenchmark.h.

Public Member Functions

 TBenchmark ()
 Benchmark default constructor. More...
virtual ~TBenchmark ()
 Benchmark destructor. More...
Int_t GetBench (const char *name) const
 Returns index of Benchmark name. More...
Float_t GetCpuTime (const char *name)
 Returns Cpu time used by Benchmark name. More...
Float_t GetRealTime (const char *name)
 Returns Realtime used by Benchmark name. More...
virtual void Print (Option_t *name="") const
 Prints parameters of Benchmark name. More...
virtual void Reset ()
 Reset all Benchmarks. More...
virtual void Show (const char *name)
 Stops Benchmark name and Prints results. More...
virtual void Start (const char *name)
 Starts Benchmark with the specified name. More...
virtual void Stop (const char *name)
 Terminates Benchmark with specified name. More...
virtual void Summary (Float_t &rt, Float_t &cp)
 Prints a summary of all benchmarks. More...
- Public Member Functions inherited from TNamed
 TNamed ()
 TNamed (const char *name, const char *title)
 TNamed (const TString &name, const TString &title)
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
virtual ~TNamed ()
 TNamed destructor. More...
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
virtual void Copy (TObject &named) const
 Copy this to obj. More...
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
virtual const char * GetName () const
 Returns name of object. More...
virtual const char * GetTitle () const
 Returns title of object. More...
virtual ULong_t Hash () const
 Return hash value for this object. More...
virtual Bool_t IsSortable () const
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 TObject (const TObject &object)
 TObject copy ctor. More...
virtual ~TObject ()
 TObject destructor. More...
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
ULong_t CheckedHash ()
 Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
virtual void Delete (Option_t *option="")
 Delete this object. More...
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
virtual void Dump () const
 Dump contents of object on stdout. More...
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
virtual const char * GetIconName () const
 Returns mime type name of object. More...
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
virtual Option_tGetOption () const
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
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. More...
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
void InvertBit (UInt_t f)
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
R__ALWAYS_INLINE Bool_t IsOnHeap () const
R__ALWAYS_INLINE Bool_t IsZombie () const
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). More...
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
void operator delete (void *ptr)
 Operator delete. More...
void operator delete[] (void *ptr)
 Operator delete []. More...
voidoperator new (size_t sz)
voidoperator new (size_t sz, void *vp)
voidoperator new[] (size_t sz)
voidoperator new[] (size_t sz, void *vp)
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
void ResetBit (UInt_t f)
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
void SetBit (UInt_t f)
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
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. More...
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...

Protected Member Functions

 TBenchmark (const TBenchmark &)
 Copy constructor. More...
TBenchmarkoperator= (const TBenchmark &)
 Assignment operator. More...
- 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). More...
void MakeZombie ()

Protected Attributes

Int_t fNbench
Int_t fNmax
- Protected Attributes inherited from TNamed
TString fName
TString fTitle

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...

#include <TBenchmark.h>

Inheritance diagram for TBenchmark:

Constructor & Destructor Documentation

◆ TBenchmark() [1/2]

TBenchmark::TBenchmark ( const TBenchmark bm)

Copy constructor.

Definition at line 41 of file TBenchmark.cxx.

◆ TBenchmark() [2/2]

TBenchmark::TBenchmark ( )

Benchmark default constructor.

Definition at line 28 of file TBenchmark.cxx.

◆ ~TBenchmark()

TBenchmark::~TBenchmark ( )

Benchmark destructor.

Definition at line 96 of file TBenchmark.cxx.

Member Function Documentation

◆ GetBench()

Int_t TBenchmark::GetBench ( const char *  name) const

Returns index of Benchmark name.

Definition at line 108 of file TBenchmark.cxx.

◆ GetCpuTime()

Float_t TBenchmark::GetCpuTime ( const char *  name)

Returns Cpu time used by Benchmark name.

Definition at line 119 of file TBenchmark.cxx.

◆ GetRealTime()

Float_t TBenchmark::GetRealTime ( const char *  name)

Returns Realtime used by Benchmark name.

Definition at line 129 of file TBenchmark.cxx.

◆ operator=()

TBenchmark & TBenchmark::operator= ( const TBenchmark bm)

Assignment operator.

Definition at line 66 of file TBenchmark.cxx.

◆ Print()

void TBenchmark::Print ( Option_t name = "") const

Prints parameters of Benchmark name.

Reimplemented from TNamed.

Definition at line 139 of file TBenchmark.cxx.

◆ Reset()

void TBenchmark::Reset ( )

Reset all Benchmarks.

Definition at line 149 of file TBenchmark.cxx.

◆ Show()

void TBenchmark::Show ( const char *  name)

Stops Benchmark name and Prints results.

Definition at line 157 of file TBenchmark.cxx.

◆ Start()

void TBenchmark::Start ( const char *  name)

Starts Benchmark with the specified name.

An independent timer (see class TStopwatch) is started. The name of the benchmark is entered into the list of benchmarks. Benchmark can be stopped via TBenchmark::Stop(). Results can be printed via TBenchmark::Print(). TBenchmark::Show() can be used to stop benchmark and print results. If name is an already existing benchmark, timing will resume. A summary of all benchmarks can be seen via TBenchmark::Summary().

Definition at line 174 of file TBenchmark.cxx.

◆ Stop()

void TBenchmark::Stop ( const char *  name)

Terminates Benchmark with specified name.

Definition at line 203 of file TBenchmark.cxx.

◆ Summary()

void TBenchmark::Summary ( Float_t rt,
Float_t cp 

Prints a summary of all benchmarks.

Definition at line 216 of file TBenchmark.cxx.

Member Data Documentation

◆ fCpuTime

Float_t* TBenchmark::fCpuTime

Definition at line 37 of file TBenchmark.h.

◆ fNames

TString* TBenchmark::fNames

Definition at line 35 of file TBenchmark.h.

◆ fNbench

Int_t TBenchmark::fNbench

Definition at line 33 of file TBenchmark.h.

◆ fNmax

Int_t TBenchmark::fNmax

Definition at line 34 of file TBenchmark.h.

◆ fRealTime

Float_t* TBenchmark::fRealTime

Definition at line 36 of file TBenchmark.h.

◆ fTimer

TStopwatch* TBenchmark::fTimer

Definition at line 38 of file TBenchmark.h.

Libraries for TBenchmark:

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