Logo ROOT  
Reference Guide
RooAcceptReject Class Reference

Class RooAcceptReject is a generic toy monte carlo generator implement the accept/reject sampling technique on any positively valued function.

The RooAcceptReject generator is used by the various generator context classes to take care of generation of observables for which p.d.fs do not define internal methods

Definition at line 29 of file RooAcceptReject.h.

Public Member Functions

 RooAcceptReject ()
 
 RooAcceptReject (const RooAbsReal &func, const RooArgSet &genVars, const RooNumGenConfig &config, bool verbose=false, const RooAbsReal *maxFuncVal=nullptr)
 Initialize an accept-reject generator for the specified distribution function, which must be non-negative but does not need to be normalized over the variables to be generated, genVars. More...
 
bool canSampleCategories () const override
 
bool canSampleConditional () const override
 
RooAbsNumGeneratorclone (const RooAbsReal &func, const RooArgSet &genVars, const RooArgSet &, const RooNumGenConfig &config, bool verbose=false, const RooAbsReal *maxFuncVal=nullptr) const override
 
const RooArgSetgenerateEvent (UInt_t remaining, double &resampleRatio) override
 Return a pointer to a generated event. More...
 
double getFuncMax () override
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooAbsNumGenerator
 RooAbsNumGenerator ()
 
 RooAbsNumGenerator (const RooAbsReal &func, const RooArgSet &genVars, bool verbose=false, const RooAbsReal *maxFuncVal=nullptr)
 Initialize an accept-reject generator for the specified distribution function, which must be non-negative but does not need to be normalized over the variables to be generated, genVars. More...
 
 ~RooAbsNumGenerator () override
 Destructor. More...
 
void attachParameters (const RooArgSet &vars)
 Reattach original parameters to function clone. More...
 
virtual bool canSampleCategories () const
 
virtual bool canSampleConditional () const
 
virtual RooAbsNumGeneratorclone (const RooAbsReal &, const RooArgSet &genVars, const RooArgSet &condVars, const RooNumGenConfig &config, bool verbose=false, const RooAbsReal *maxFuncVal=nullptr) const =0
 
virtual const RooArgSetgenerateEvent (UInt_t remaining, double &resampleRatio)=0
 
virtual double getFuncMax ()
 
TClassIsA () const override
 
bool isValid () const
 
bool isVerbose () const
 
void Print (Option_t *options=nullptr) const override
 Print TNamed name and title. More...
 
void printArgs (std::ostream &os) const override
 Print the arguments of the generator. More...
 
void printClassName (std::ostream &os) const override
 Print the class name of the generator. More...
 
void printName (std::ostream &os) const override
 Print name of the generator. More...
 
void printTitle (std::ostream &os) const override
 Print the title of the generator. More...
 
void setVerbose (bool verbose=true)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
void Clear (Option_t *option="") override
 Set name and title to empty strings (""). More...
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility. More...
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects. More...
 
void Copy (TObject &named) const override
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
const char * GetName () const override
 Returns name of object. More...
 
const char * GetTitle () const override
 Returns title of object. More...
 
ULong_t Hash () const override
 Return hash value for this object. More...
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
void Print (Option_t *option="") const override
 Print TNamed name and title. 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...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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=nullptr)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 TClassIsA () const
 
Bool_t IsDestructed () const
 IsDestructed. 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 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...
 
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)
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=nullptr, 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 TClassIsA () 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 printClassName (std::ostream &os) const
 Print class name of object. More...
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const
 Interface for detailed printing of object. More...
 
virtual void printName (std::ostream &os) const
 Print name 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 printTitle (std::ostream &os) const
 Print title of object. 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...
 
virtual void Streamer (TBuffer &)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooAbsNumGenerator
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_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 TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
 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...
 

Protected Member Functions

void addEventToCache ()
 Add a trial event to our cache and update our estimates of the function maximum value and integral. More...
 
const RooArgSetnextAcceptedEvent ()
 Scan through events in the cache which have not been used yet, looking for the first accepted one which is added to the specified container. 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 ()
 

Static Protected Member Functions

static void registerSampler (RooNumGenFactory &fact)
 Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory. More...
 

Protected Attributes

UInt_t _catSampleMult
 Number of real and discrete dimensions to be sampled. More...
 
UInt_t _eventsUsed
 Accepted number of function samples. More...
 
double _funcSum
 Maximum function value found, and sum of all samples made. More...
 
double _maxFuncVal
 
UInt_t _minTrials
 Minimum number of max.finding trials, total number of samples. More...
 
UInt_t _minTrialsArray [4]
 Minimum number of trials samples for 1,2,3 dimensional problems. More...
 
UInt_t _realSampleDim
 
UInt_t _totalEvents
 Total number of function samples. More...
 
- Protected Attributes inherited from RooAbsNumGenerator
RooDataSet_cache
 Dataset holding generared values of observables. More...
 
RooArgSet _catVars
 
RooArgSet_cloneSet
 Set owning clone of input function. More...
 
RooAbsReal_funcClone
 Pointer to top level node of cloned function. More...
 
const RooAbsReal_funcMaxVal
 Container for maximum function value. More...
 
RooRealVar_funcValPtr
 RRVs storing function value in context and in output dataset. More...
 
RooRealVar_funcValStore
 
bool _isValid
 Verbose and valid flag. More...
 
RooArgSet _realVars
 Sets of discrete and real valued observabeles. More...
 
bool _verbose
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Friends

class RooNumGenFactory
 

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 ))
}
 
- 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
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooAcceptReject.h>

Inheritance diagram for RooAcceptReject:
[legend]

Constructor & Destructor Documentation

◆ RooAcceptReject() [1/2]

RooAcceptReject::RooAcceptReject ( )
inline

Definition at line 31 of file RooAcceptReject.h.

◆ RooAcceptReject() [2/2]

RooAcceptReject::RooAcceptReject ( const RooAbsReal func,
const RooArgSet genVars,
const RooNumGenConfig config,
bool  verbose = false,
const RooAbsReal maxFuncVal = nullptr 
)

Initialize an accept-reject generator for the specified distribution function, which must be non-negative but does not need to be normalized over the variables to be generated, genVars.

The function and its dependents are cloned and so will not be disturbed during the generation process.

Definition at line 75 of file RooAcceptReject.cxx.

Member Function Documentation

◆ addEventToCache()

void RooAcceptReject::addEventToCache ( )
protected

Add a trial event to our cache and update our estimates of the function maximum value and integral.

Definition at line 273 of file RooAcceptReject.cxx.

◆ canSampleCategories()

bool RooAcceptReject::canSampleCategories ( ) const
inlineoverridevirtual

Reimplemented from RooAbsNumGenerator.

Definition at line 46 of file RooAcceptReject.h.

◆ canSampleConditional()

bool RooAcceptReject::canSampleConditional ( ) const
inlineoverridevirtual

Reimplemented from RooAbsNumGenerator.

Definition at line 45 of file RooAcceptReject.h.

◆ Class()

static TClass * RooAcceptReject::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooAcceptReject::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static Version_t RooAcceptReject::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 65 of file RooAcceptReject.h.

◆ clone()

RooAbsNumGenerator * RooAcceptReject::clone ( const RooAbsReal func,
const RooArgSet genVars,
const RooArgSet ,
const RooNumGenConfig config,
bool  verbose = false,
const RooAbsReal maxFuncVal = nullptr 
) const
inlineoverridevirtual

Implements RooAbsNumGenerator.

Definition at line 35 of file RooAcceptReject.h.

◆ DeclFileName()

static const char * RooAcceptReject::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 65 of file RooAcceptReject.h.

◆ generateEvent()

const RooArgSet * RooAcceptReject::generateEvent ( UInt_t  remaining,
double resampleRatio 
)
overridevirtual

Return a pointer to a generated event.

The caller does not own the event and it will be overwritten by a subsequent call. The input parameter 'remaining' should contain your best guess at the total number of subsequent events you will request.

Implements RooAbsNumGenerator.

Definition at line 154 of file RooAcceptReject.cxx.

◆ getFuncMax()

double RooAcceptReject::getFuncMax ( )
overridevirtual

Reimplemented from RooAbsNumGenerator.

Definition at line 301 of file RooAcceptReject.cxx.

◆ IsA()

TClass * RooAcceptReject::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from RooAbsNumGenerator.

Definition at line 65 of file RooAcceptReject.h.

◆ nextAcceptedEvent()

const RooArgSet * RooAcceptReject::nextAcceptedEvent ( )
protected

Scan through events in the cache which have not been used yet, looking for the first accepted one which is added to the specified container.

Return a pointer to the accepted event, or else zero if we use up the cache before we accept an event. The caller does not own the event and it will be overwritten by a subsequent call.

Definition at line 244 of file RooAcceptReject.cxx.

◆ registerSampler()

void RooAcceptReject::registerSampler ( RooNumGenFactory fact)
staticprotected

Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.

Definition at line 56 of file RooAcceptReject.cxx.

◆ Streamer()

void RooAcceptReject::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsNumGenerator.

◆ StreamerNVirtual()

void RooAcceptReject::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 65 of file RooAcceptReject.h.

Friends And Related Function Documentation

◆ RooNumGenFactory

friend class RooNumGenFactory
friend

Definition at line 51 of file RooAcceptReject.h.

Member Data Documentation

◆ _catSampleMult

UInt_t RooAcceptReject::_catSampleMult
protected

Number of real and discrete dimensions to be sampled.

Definition at line 58 of file RooAcceptReject.h.

◆ _eventsUsed

UInt_t RooAcceptReject::_eventsUsed
protected

Accepted number of function samples.

Definition at line 61 of file RooAcceptReject.h.

◆ _funcSum

double RooAcceptReject::_funcSum
protected

Maximum function value found, and sum of all samples made.

Definition at line 57 of file RooAcceptReject.h.

◆ _maxFuncVal

double RooAcceptReject::_maxFuncVal
protected

Definition at line 57 of file RooAcceptReject.h.

◆ _minTrials

UInt_t RooAcceptReject::_minTrials
protected

Minimum number of max.finding trials, total number of samples.

Definition at line 59 of file RooAcceptReject.h.

◆ _minTrialsArray

UInt_t RooAcceptReject::_minTrialsArray[4]
protected

Minimum number of trials samples for 1,2,3 dimensional problems.

Definition at line 63 of file RooAcceptReject.h.

◆ _realSampleDim

UInt_t RooAcceptReject::_realSampleDim
protected

Definition at line 58 of file RooAcceptReject.h.

◆ _totalEvents

UInt_t RooAcceptReject::_totalEvents
protected

Total number of function samples.

Definition at line 60 of file RooAcceptReject.h.

Libraries for RooAcceptReject:
[legend]

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