Logo ROOT  
Reference Guide
RooProdGenContext Class Reference

RooProdGenContext is an efficient implementation of the generator context specific for RooProdPdf PDFs.

The sim-context owns a list of component generator contexts that are used to generate the dependents for each component PDF sequentially.

Definition at line 30 of file RooProdGenContext.h.

Public Member Functions

 RooProdGenContext (const RooProdPdf &model, const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool _verbose=false)
 
 ~RooProdGenContext () override
 Destructor. Delete all owned subgenerator contexts. More...
 
void attach (const RooArgSet &params) override
 Attach generator to given event buffer. More...
 
TClassIsA () const override
 
void printMultiline (std::ostream &os, Int_t content, bool verbose=false, TString indent="") const override
 Detailed printing interface. More...
 
void setProtoDataOrder (Int_t *lut) override
 Set the traversal order of the prototype dataset by the given lookup table. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooAbsGenContext
 RooAbsGenContext (const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool _verbose=false)
 Constructor. More...
 
virtual void attach (const RooArgSet &params)
 Interface to attach given parameters to object in this context. More...
 
Int_t defaultPrintContents (Option_t *opt) const override
 Define default contents when printing. More...
 
StyleOption defaultPrintStyle (Option_t *opt) const override
 Define default print style. More...
 
virtual RooDataSetgenerate (double nEvents=0, bool skipInit=false, bool extendedMode=false)
 Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events. More...
 
virtual void generateEvent (RooArgSet &theEvent, Int_t remaining)=0
 
virtual void initGenerator (const RooArgSet &theEvent)
 Interface function to initialize context for generation for given set of observables. More...
 
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 arguments of context, i.e. the observables being generated in this context. More...
 
void printClassName (std::ostream &os) const override
 Print class name of context. More...
 
void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
 Interface for multi-line printing. More...
 
void printName (std::ostream &os) const override
 Print name of context. More...
 
void printTitle (std::ostream &os) const override
 Print title of context. More...
 
virtual void setExpectedData (bool)
 
virtual void setProtoDataOrder (Int_t *lut)
 Set the traversal order of prototype data to that in the lookup tables passed as argument. 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 RooAbsGenContext
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

 RooProdGenContext (const RooProdGenContext &other)
 
void generateEvent (RooArgSet &theEvent, Int_t remaining) override
 Generate a single event of the product by generating the components of the products sequentially. More...
 
void initGenerator (const RooArgSet &theEvent) override
 One-time initialization of generator context, forward to component generators. More...
 
void updateCCDTable ()
 
- Protected Member Functions inherited from RooAbsGenContext
virtual RooDataSetcreateDataSet (const char *name, const char *title, const RooArgSet &obs)
 Create an empty dataset to hold the events that will be generated. More...
 
void resampleData (double &ratio)
 Rescale existing output buffer with given ratio. 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

RooArgSet_ccdCloneSet
 
bool _ccdRefresh
 
RooSuperCategory_ccdSuper
 SuperCategory of Common category dependents. More...
 
double_ccdTable
 
RooArgSet _commonCats
 Common category dependents. More...
 
std::list< RooAbsGenContext * > _gcList
 List of component generator contexts. More...
 
RooArgSet _ownedMultiProds
 Owned auxiliary multi-term product PDFs. More...
 
const RooProdPdf_pdf
 Original PDF. More...
 
RooRealIntegral_pdfCcdInt
 
RooAbsPdf_pdfClone
 
RooArgSet_pdfCloneSet
 
RooArgSet _uniObs
 Observable to be generated with flat distribution. More...
 
- Protected Attributes inherited from RooAbsGenContext
UInt_t _expectedEvents
 Number of expected events from extended p.d.f. More...
 
RooAbsPdf::ExtendMode _extendMode
 Extended mode capabilities of p.d.f. More...
 
RooDataSet_genData
 ! Data being generated More...
 
bool _isValid
 Is context in valid state? More...
 
Int_t _nextProtoIndex
 Next prototype event to load according to LUT. More...
 
TString _normRange
 Normalization range of pdf. More...
 
std::vector< Int_t_protoOrder
 LUT with traversal order of prototype data. More...
 
const RooDataSet_prototype
 Pointer to prototype dataset. More...
 
RooArgSet _protoVars
 Prototype observables. More...
 
RooArgSet _theEvent
 Pointer to observable event being generated. More...
 
bool _verbose
 Verbose messaging? More...
 
- 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 = (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 <RooProdGenContext.h>

Inheritance diagram for RooProdGenContext:
[legend]

Constructor & Destructor Documentation

◆ RooProdGenContext() [1/2]

RooProdGenContext::RooProdGenContext ( const RooProdPdf model,
const RooArgSet vars,
const RooDataSet prototype = nullptr,
const RooArgSet auxProto = nullptr,
bool  _verbose = false 
)

Definition at line 47 of file RooProdGenContext.cxx.

◆ ~RooProdGenContext()

RooProdGenContext::~RooProdGenContext ( )
override

Destructor. Delete all owned subgenerator contexts.

Definition at line 301 of file RooProdGenContext.cxx.

◆ RooProdGenContext() [2/2]

RooProdGenContext::RooProdGenContext ( const RooProdGenContext other)
protected

Member Function Documentation

◆ attach()

void RooProdGenContext::attach ( const RooArgSet params)
overridevirtual

Attach generator to given event buffer.

Reimplemented from RooAbsGenContext.

Definition at line 312 of file RooProdGenContext.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 64 of file RooProdGenContext.h.

◆ DeclFileName()

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

Definition at line 64 of file RooProdGenContext.h.

◆ generateEvent()

void RooProdGenContext::generateEvent ( RooArgSet theEvent,
Int_t  remaining 
)
overrideprotectedvirtual

Generate a single event of the product by generating the components of the products sequentially.

The subcontext have been order such that all conditional dependencies are correctly taken into account when processed in sequential order

Implements RooAbsGenContext.

Definition at line 340 of file RooProdGenContext.cxx.

◆ initGenerator()

void RooProdGenContext::initGenerator ( const RooArgSet theEvent)
overrideprotectedvirtual

One-time initialization of generator context, forward to component generators.

Reimplemented from RooAbsGenContext.

Definition at line 324 of file RooProdGenContext.cxx.

◆ IsA()

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

Reimplemented from RooAbsGenContext.

Definition at line 64 of file RooProdGenContext.h.

◆ printMultiline()

void RooProdGenContext::printMultiline ( std::ostream &  os,
Int_t  content,
bool  verbose = false,
TString  indent = "" 
) const
overridevirtual

Detailed printing interface.

Reimplemented from RooAbsGenContext.

Definition at line 382 of file RooProdGenContext.cxx.

◆ setProtoDataOrder()

void RooProdGenContext::setProtoDataOrder ( Int_t lut)
overridevirtual

Set the traversal order of the prototype dataset by the given lookup table.

Reimplemented from RooAbsGenContext.

Definition at line 366 of file RooProdGenContext.cxx.

◆ Streamer()

void RooProdGenContext::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsGenContext.

◆ StreamerNVirtual()

void RooProdGenContext::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 64 of file RooProdGenContext.h.

◆ updateCCDTable()

void RooProdGenContext::updateCCDTable ( )
protected

Member Data Documentation

◆ _ccdCloneSet

RooArgSet* RooProdGenContext::_ccdCloneSet
protected

Definition at line 52 of file RooProdGenContext.h.

◆ _ccdRefresh

bool RooProdGenContext::_ccdRefresh
protected

Definition at line 58 of file RooProdGenContext.h.

◆ _ccdSuper

RooSuperCategory* RooProdGenContext::_ccdSuper
protected

SuperCategory of Common category dependents.

Definition at line 53 of file RooProdGenContext.h.

◆ _ccdTable

double* RooProdGenContext::_ccdTable
protected

Definition at line 59 of file RooProdGenContext.h.

◆ _commonCats

RooArgSet RooProdGenContext::_commonCats
protected

Common category dependents.

Definition at line 51 of file RooProdGenContext.h.

◆ _gcList

std::list<RooAbsGenContext*> RooProdGenContext::_gcList
protected

List of component generator contexts.

Definition at line 61 of file RooProdGenContext.h.

◆ _ownedMultiProds

RooArgSet RooProdGenContext::_ownedMultiProds
protected

Owned auxiliary multi-term product PDFs.

Definition at line 62 of file RooProdGenContext.h.

◆ _pdf

const RooProdPdf* RooProdGenContext::_pdf
protected

Original PDF.

Definition at line 60 of file RooProdGenContext.h.

◆ _pdfCcdInt

RooRealIntegral* RooProdGenContext::_pdfCcdInt
protected

Definition at line 56 of file RooProdGenContext.h.

◆ _pdfClone

RooAbsPdf* RooProdGenContext::_pdfClone
protected

Definition at line 55 of file RooProdGenContext.h.

◆ _pdfCloneSet

RooArgSet* RooProdGenContext::_pdfCloneSet
protected

Definition at line 54 of file RooProdGenContext.h.

◆ _uniObs

RooArgSet RooProdGenContext::_uniObs
protected

Observable to be generated with flat distribution.

Definition at line 57 of file RooProdGenContext.h.

Libraries for RooProdGenContext:
[legend]

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