Logo ROOT  
Reference Guide
RooGrid Class Reference

RooGrid is a utility class for RooMCIntegrator which implements an adaptive multi-dimensional Monte Carlo numerical integration, following the VEGAS algorithm.

Definition at line 24 of file RooGrid.h.

Public Types

enum  { maxBins = 50 }
 
- 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)
}
 
- Public Types inherited from RooPrintable
enum  ContentsOption {
  kName =1, kClassName =2, kValue =4, kArgs =8,
  kExtras =16, kAddress =32, kTitle =64, kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1, kSingleLine =2, kStandard =3, kVerbose =4,
  kTreeStructure =5
}
 

Public Member Functions

 RooGrid ()
 Default constructor. More...
 
 RooGrid (const RooAbsFunc &function)
 Constructor with given function binding. More...
 
virtual ~RooGrid ()
 Destructor. More...
 
void accumulate (const UInt_t bin[], Double_t amount)
 Add the specified amount to bin[j] of the 1D histograms associated with each axis j. More...
 
Double_t coord (Int_t i, Int_t j) const
 
UInt_tcreateIndexVector () const
 
Double_tcreatePoint () const
 
void firstBox (UInt_t box[]) const
 Reset the specified array of box indices to refer to the first box in the standard traversal order. More...
 
void generatePoint (const UInt_t box[], Double_t x[], UInt_t bin[], Double_t &vol, Bool_t useQuasiRandom=kTRUE) const
 Generate a random vector in the specified box and and store its coordinates in the x[] array provided, the corresponding bin indices in the bin[] array, and the volume of this bin in vol. More...
 
UInt_t getDimension () const
 
UInt_t getNBins () const
 
UInt_t getNBoxes () const
 
Double_t getVolume () const
 
Bool_t initialize (const RooAbsFunc &function)
 Calculate and store the grid dimensions and volume using the specified function, and initialize the grid using a single bin. More...
 
Bool_t isValid () const
 
Bool_t nextBox (UInt_t box[]) const
 Update the specified array of box indices to refer to the next box in the standard traversal order and return kTRUE, or else return kFALSE if we the indices already refer to the last box. More...
 
virtual void Print (Option_t *options=0) const
 This method must be overridden when a class wants to print itself. More...
 
virtual void printClassName (std::ostream &os) const
 Print class name of grid object. More...
 
virtual void printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
 Print info about this object to the specified stream. More...
 
virtual void printName (std::ostream &os) const
 Print name of grid object. More...
 
virtual void printTitle (std::ostream &os) const
 Print title of grid object. More...
 
void refine (Double_t alpha=1.5)
 Refine the grid using the values that have been accumulated so far. More...
 
void resetValues ()
 Reset the values associated with each grid cell. More...
 
void resize (UInt_t bins)
 Adjust the subdivision of each axis to give the specified number of bins, using an algorithm that preserves relative bin density. More...
 
void setNBoxes (UInt_t boxes)
 
Double_t value (Int_t i, Int_t j) const
 
- 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 ()
 Check and record whether 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 Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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
 
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. More...
 
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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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...
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Default choice of contents to be printed (name and value) More...
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printArgs (std::ostream &os) const
 Interface for printing of object arguments. More...
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object. More...
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object. More...
 

Protected Member Functions

Double_tcoord (Int_t i, Int_t j)
 
Double_tnewCoord (Int_t i)
 
Double_tvalue (Int_t i, Int_t j)
 
- 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

UInt_t _bins
 
UInt_t _boxes
 
Double_t_d
 Internal workspace. More...
 
Double_t_delx
 Internal workspace. More...
 
UInt_t _dim
 
Bool_t _valid
 
Double_t _vol
 
Double_t_weight
 Internal workspace. More...
 
Double_t_xi
 Internal workspace. More...
 
Double_t_xin
 Internal workspace. More...
 
Double_t_xl
 
Double_t_xu
 Internal workspace. More...
 

Additional Inherited Members

- 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...
 
- Static Public Member Functions inherited from RooPrintable
static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooGrid.h>

Inheritance diagram for RooGrid:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
maxBins 

Definition at line 61 of file RooGrid.h.

Constructor & Destructor Documentation

◆ RooGrid() [1/2]

RooGrid::RooGrid ( )

Default constructor.

Definition at line 50 of file RooGrid.cxx.

◆ RooGrid() [2/2]

RooGrid::RooGrid ( const RooAbsFunc function)

Constructor with given function binding.

Definition at line 59 of file RooGrid.cxx.

◆ ~RooGrid()

RooGrid::~RooGrid ( )
virtual

Destructor.

Definition at line 91 of file RooGrid.cxx.

Member Function Documentation

◆ accumulate()

void RooGrid::accumulate ( const UInt_t  bin[],
Double_t  amount 
)

Add the specified amount to bin[j] of the 1D histograms associated with each axis j.

Definition at line 326 of file RooGrid.cxx.

◆ coord() [1/2]

Double_t& RooGrid::coord ( Int_t  i,
Int_t  j 
)
inlineprotected

Definition at line 68 of file RooGrid.h.

◆ coord() [2/2]

Double_t RooGrid::coord ( Int_t  i,
Int_t  j 
) const
inline

Definition at line 65 of file RooGrid.h.

◆ createIndexVector()

UInt_t* RooGrid::createIndexVector ( ) const
inline

Definition at line 48 of file RooGrid.h.

◆ createPoint()

Double_t* RooGrid::createPoint ( ) const
inline

Definition at line 47 of file RooGrid.h.

◆ firstBox()

void RooGrid::firstBox ( UInt_t  box[]) const

Reset the specified array of box indices to refer to the first box in the standard traversal order.

Definition at line 246 of file RooGrid.cxx.

◆ generatePoint()

void RooGrid::generatePoint ( const UInt_t  box[],
Double_t  x[],
UInt_t  bin[],
Double_t vol,
Bool_t  useQuasiRandom = kTRUE 
) const

Generate a random vector in the specified box and and store its coordinates in the x[] array provided, the corresponding bin indices in the bin[] array, and the volume of this bin in vol.

The box is specified by the array box[] of box integer indices that each range from 0 to getNBoxes()-1.

Definition at line 198 of file RooGrid.cxx.

◆ getDimension()

UInt_t RooGrid::getDimension ( ) const
inline

Definition at line 41 of file RooGrid.h.

◆ getNBins()

UInt_t RooGrid::getNBins ( ) const
inline

Definition at line 43 of file RooGrid.h.

◆ getNBoxes()

UInt_t RooGrid::getNBoxes ( ) const
inline

Definition at line 44 of file RooGrid.h.

◆ getVolume()

Double_t RooGrid::getVolume ( ) const
inline

Definition at line 42 of file RooGrid.h.

◆ initialize()

Bool_t RooGrid::initialize ( const RooAbsFunc function)

Calculate and store the grid dimensions and volume using the specified function, and initialize the grid using a single bin.

Return kTRUE, or else kFALSE if the range is not valid.

Definition at line 108 of file RooGrid.cxx.

◆ isValid()

Bool_t RooGrid::isValid ( ) const
inline

Definition at line 40 of file RooGrid.h.

◆ newCoord()

Double_t& RooGrid::newCoord ( Int_t  i)
inlineprotected

Definition at line 70 of file RooGrid.h.

◆ nextBox()

Bool_t RooGrid::nextBox ( UInt_t  box[]) const

Update the specified array of box indices to refer to the next box in the standard traversal order and return kTRUE, or else return kFALSE if we the indices already refer to the last box.

Definition at line 258 of file RooGrid.cxx.

◆ Print()

virtual void RooGrid::Print ( Option_t option = 0) const
inlinevirtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 36 of file RooGrid.h.

◆ printClassName()

void RooGrid::printClassName ( std::ostream &  os) const
virtual

Print class name of grid object.

Reimplemented from RooPrintable.

Definition at line 315 of file RooGrid.cxx.

◆ printMultiline()

void RooGrid::printMultiline ( std::ostream &  os,
Int_t  contents,
Bool_t  verbose = kFALSE,
TString  indent = "" 
) const
virtual

Print info about this object to the specified stream.

Reimplemented from RooPrintable.

Definition at line 277 of file RooGrid.cxx.

◆ printName()

void RooGrid::printName ( std::ostream &  os) const
virtual

Print name of grid object.

Reimplemented from RooPrintable.

Definition at line 297 of file RooGrid.cxx.

◆ printTitle()

void RooGrid::printTitle ( std::ostream &  os) const
virtual

Print title of grid object.

Reimplemented from RooPrintable.

Definition at line 306 of file RooGrid.cxx.

◆ refine()

void RooGrid::refine ( Double_t  alpha = 1.5)

Refine the grid using the values that have been accumulated so far.

The parameter alpha controls the stiffness of the rebinning and should usually be between 1 (stiffer) and 2 (more flexible). A value of zero prevents any rebinning.

Definition at line 338 of file RooGrid.cxx.

◆ resetValues()

void RooGrid::resetValues ( )

Reset the values associated with each grid cell.

Definition at line 181 of file RooGrid.cxx.

◆ resize()

void RooGrid::resize ( UInt_t  bins)

Adjust the subdivision of each axis to give the specified number of bins, using an algorithm that preserves relative bin density.

The new binning can be finer or coarser than the original binning.

Definition at line 144 of file RooGrid.cxx.

◆ setNBoxes()

void RooGrid::setNBoxes ( UInt_t  boxes)
inline

Definition at line 45 of file RooGrid.h.

◆ value() [1/2]

Double_t& RooGrid::value ( Int_t  i,
Int_t  j 
)
inlineprotected

Definition at line 69 of file RooGrid.h.

◆ value() [2/2]

Double_t RooGrid::value ( Int_t  i,
Int_t  j 
) const
inline

Definition at line 66 of file RooGrid.h.

Member Data Documentation

◆ _bins

UInt_t RooGrid::_bins
protected

Definition at line 75 of file RooGrid.h.

◆ _boxes

UInt_t RooGrid::_boxes
protected

Definition at line 75 of file RooGrid.h.

◆ _d

Double_t* RooGrid::_d
protected

Internal workspace.

Definition at line 81 of file RooGrid.h.

◆ _delx

Double_t* RooGrid::_delx
protected

Internal workspace.

Definition at line 80 of file RooGrid.h.

◆ _dim

UInt_t RooGrid::_dim
protected

Definition at line 75 of file RooGrid.h.

◆ _valid

Bool_t RooGrid::_valid
protected

Definition at line 74 of file RooGrid.h.

◆ _vol

Double_t RooGrid::_vol
protected

Definition at line 76 of file RooGrid.h.

◆ _weight

Double_t* RooGrid::_weight
protected

Internal workspace.

Definition at line 84 of file RooGrid.h.

◆ _xi

Double_t* RooGrid::_xi
protected

Internal workspace.

Definition at line 82 of file RooGrid.h.

◆ _xin

Double_t* RooGrid::_xin
protected

Internal workspace.

Definition at line 83 of file RooGrid.h.

◆ _xl

Double_t* RooGrid::_xl
protected

Definition at line 78 of file RooGrid.h.

◆ _xu

Double_t* RooGrid::_xu
protected

Internal workspace.

Definition at line 79 of file RooGrid.h.

Libraries for RooGrid:
[legend]

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