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	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

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

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...

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...

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	Print (Option_t *options=0) const
	This method must be overridden when a class wants to print itself. More...

Bool_t	isValid () const

UInt_t	getDimension () const

Double_t	getVolume () const

UInt_t	getNBins () const

UInt_t	getNBoxes () const

void	setNBoxes (UInt_t boxes)

Double_t *	createPoint () const

UInt_t *	createIndexVector () 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...

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	resetValues ()
	Reset the values associated with each grid cell. 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...

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...

void	refine (Double_t alpha=1.5)
	Refine the grid using the values that have been accumulated so far. More...

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...

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...

Double_t	coord (Int_t i, Int_t j) const

Double_t	value (Int_t i, Int_t j) const

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

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

virtual	~TObject ()
	TObject destructor. 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...

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

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. 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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

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

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

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

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

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

virtual Option_t *	GetOption () const

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

virtual const char *	GetTitle () const
	Returns title of object. 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...

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...

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

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	IsSortable () const

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. 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...

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...

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	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

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

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

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. 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)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

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

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

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

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

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. 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...

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...

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

Public Member Functions inherited from RooPrintable
	RooPrintable ()

virtual	~RooPrintable ()

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	printAddress (std::ostream &os) const
	Print class name of object. More...

virtual void	printValue (std::ostream &os) const
	Interface to print value 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	printTree (std::ostream &os, TString indent="") const
	Interface for tree structure printing of object. More...

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

Protected Member Functions
Double_t &	coord (Int_t i, Int_t j)

Double_t &	value (Int_t i, Int_t j)

Double_t &	newCoord (Int_t i)

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

Protected Attributes
Bool_t	_valid

UInt_t	_dim

UInt_t	_bins

UInt_t	_boxes

Double_t	_vol

Double_t *	_xl

Double_t *	_xu
	Internal workspace. More...

Double_t *	_delx
	Internal workspace. More...

Double_t *	_d
	Internal workspace. More...

Double_t *	_xi
	Internal workspace. More...

Double_t *	_xin
	Internal workspace. More...

Double_t *	_weight
	Internal workspace. More...

Additional Inherited Members
Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

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

static Bool_t	GetObjectStat ()
	Get status of object stat 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

Enumerator
maxBins

Definition at line 61 of file RooGrid.h.

Constructor & Destructor Documentation

RooGrid::RooGrid ( )

Default constructor.

Definition at line 51 of file RooGrid.cxx.

RooGrid::RooGrid ( const RooAbsFunc & function )

Constructor with given function binding.

Definition at line 60 of file RooGrid.cxx.

RooGrid::~RooGrid ( )

virtual

Destructor.

Definition at line 92 of file RooGrid.cxx.

Member Function Documentation

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 327 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

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

inline

Definition at line 65 of file RooGrid.h.

Referenced by generatePoint(), initialize(), printMultiline(), refine(), and resize().

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

inlineprotected

Definition at line 68 of file RooGrid.h.

UInt_t* RooGrid::createIndexVector ( ) const

inline

Definition at line 48 of file RooGrid.h.

Referenced by RooMCIntegrator::vegas().

Double_t* RooGrid::createPoint ( ) const

inline

Definition at line 47 of file RooGrid.h.

Referenced by RooMCIntegrator::vegas().

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 247 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

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 199 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

UInt_t RooGrid::getDimension ( ) const

inline

Definition at line 41 of file RooGrid.h.

Referenced by RooMCIntegrator::integral(), printMultiline(), and RooMCIntegrator::vegas().

UInt_t RooGrid::getNBins ( ) const

inline

Definition at line 43 of file RooGrid.h.

Referenced by printMultiline(), and RooMCIntegrator::vegas().

UInt_t RooGrid::getNBoxes ( ) const

inline

Definition at line 44 of file RooGrid.h.

Double_t RooGrid::getVolume ( ) const

inline

Definition at line 42 of file RooGrid.h.

Referenced by printMultiline(), and RooMCIntegrator::vegas().

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 109 of file RooGrid.cxx.

Referenced by RooMCIntegrator::checkLimits(), RooGrid(), and RooMCIntegrator::vegas().

Bool_t RooGrid::isValid ( ) const

inline

Definition at line 40 of file RooGrid.h.

Referenced by RooGrid(), and RooMCIntegrator::RooMCIntegrator().

Double_t& RooGrid::newCoord ( Int_t i )

inlineprotected

Definition at line 70 of file RooGrid.h.

Referenced by refine(), and resize().

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 259 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

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.

Referenced by RooMCIntegrator::RooMCIntegrator(), and RooMCIntegrator::vegas().

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

virtual

Print class name of grid object.

Reimplemented from RooPrintable.

Definition at line 316 of file RooGrid.cxx.

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 278 of file RooGrid.cxx.

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

virtual

Print name of grid object.

Reimplemented from RooPrintable.

Definition at line 298 of file RooGrid.cxx.

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

virtual

Print title of grid object.

Reimplemented from RooPrintable.

Definition at line 307 of file RooGrid.cxx.

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 339 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

void RooGrid::resetValues ( )

Reset the values associated with each grid cell.

Definition at line 182 of file RooGrid.cxx.

Referenced by RooMCIntegrator::vegas().

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 145 of file RooGrid.cxx.

Referenced by qtexample.window::__init__(), and RooMCIntegrator::vegas().

void RooGrid::setNBoxes ( UInt_t boxes )