Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsBinning Class Referenceabstract

Abstract base class for RooRealVar binning definitions.

This class defines the interface to retrieve bin boundaries, ranges etc.

Definition at line 25 of file RooAbsBinning.h.

Public Member Functions

 RooAbsBinning (const char *name=nullptr)
 
 RooAbsBinning (const RooAbsBinning &other, const char *name=nullptr)
 
virtual doublearray () const =0
 
virtual double averageBinWidth () const =0
 
virtual double binCenter (Int_t bin) const =0
 
virtual double binHigh (Int_t bin) const =0
 
virtual double binLow (Int_t bin) const =0
 
int binNumber (double x) const
 Returns the bin number corresponding to the value x.
 
virtual void binNumbers (double const *x, int *bins, std::size_t n, int coef=1) const =0
 Compute the bin indices for multiple values of x.
 
virtual double binWidth (Int_t bin) const =0
 
virtual RooAbsBinningclone (const char *name=nullptr) const =0
 
TObjectClone (const char *newname=nullptr) const override
 Make a clone of an object using the Streamer facility.
 
virtual double highBound () const =0
 
virtual RooAbsRealhighBoundFunc () const
 Return pointer to RooAbsReal parameterized upper bound, if any.
 
virtual void insertHook (RooAbsRealLValue &) const
 Hook interface function to execute code upon insertion into a RooAbsRealLValue.
 
TClassIsA () const override
 
virtual bool isParameterized () const
 Interface function.
 
virtual bool isShareable () const
 If true (default), the range definition can be shared across clones of a RooRealVar.
 
virtual bool isUniform () const
 
virtual double lowBound () const =0
 
virtual RooAbsReallowBoundFunc () const
 Return pointer to RooAbsReal parameterized lower bound, if any.
 
Int_t numBins () const
 Return number of bins.
 
virtual Int_t numBoundaries () const =0
 
void Print (Option_t *options=nullptr) const override
 This method must be overridden when a class wants to print itself.
 
void printArgs (std::ostream &os) const override
 Print binning arguments (the RooAbsReal objects represening the variable bin boundaries for parameterized binning implementations.
 
void printClassName (std::ostream &os) const override
 Print binning class name.
 
void printName (std::ostream &os) const override
 Print binning name.
 
void printTitle (std::ostream &os) const override
 Print binning title.
 
void printValue (std::ostream &os) const override
 Print binning value, i.e the bin boundary positions.
 
virtual void removeHook (RooAbsRealLValue &) const
 Hook interface function to execute code upon removal from a RooAbsRealLValue.
 
virtual void setMax (double xhi)
 Change upper bound to xhi.
 
virtual void setMin (double xlo)
 Change lower bound to xlo.
 
virtual void setRange (double xlo, double xhi)=0
 
void Streamer (TBuffer &) override
 Custom streamer implementing schema evolution between V1 and V2 persistent binnings.
 
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.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
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.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
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.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 
- 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)
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printAddress (std::ostream &os) const
 Print class name of object.
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object.
 
virtual void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const
 Interface for detailed printing of object.
 
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'.
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Static Public Member Functions inherited from RooPrintable
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr 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().
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
 

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 )) }
 
- 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).
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooAbsBinning.h>

Inheritance diagram for RooAbsBinning:
[legend]

Constructor & Destructor Documentation

◆ RooAbsBinning() [1/2]

RooAbsBinning::RooAbsBinning ( const char *  name = nullptr)
inline

Definition at line 28 of file RooAbsBinning.h.

◆ RooAbsBinning() [2/2]

RooAbsBinning::RooAbsBinning ( const RooAbsBinning other,
const char *  name = nullptr 
)
inline

Definition at line 29 of file RooAbsBinning.h.

Member Function Documentation

◆ array()

virtual double * RooAbsBinning::array ( ) const
pure virtual

◆ averageBinWidth()

virtual double RooAbsBinning::averageBinWidth ( ) const
pure virtual

◆ binCenter()

virtual double RooAbsBinning::binCenter ( Int_t  bin) const
pure virtual

◆ binHigh()

virtual double RooAbsBinning::binHigh ( Int_t  bin) const
pure virtual

◆ binLow()

virtual double RooAbsBinning::binLow ( Int_t  bin) const
pure virtual

◆ binNumber()

int RooAbsBinning::binNumber ( double  x) const
inline

Returns the bin number corresponding to the value x.

Note
This inline function is implemented by calling the vectorized function RooAbsBinning::binNumbers(). If you want to calculate the bin indices for multiple values, use that one for better performance.

Definition at line 60 of file RooAbsBinning.h.

◆ binNumbers()

virtual void RooAbsBinning::binNumbers ( double const *  x,
int bins,
std::size_t  n,
int  coef = 1 
) const
pure virtual

Compute the bin indices for multiple values of x.

For each element in the input, the corresponding output element will be increased by coef * binIdx. This is useful for aggregating multi-dimensional bin indices inplace.

param[in] x The read-only input array of values of x. param[out] bins The output array. Note that the initial values don't get replaced! The result is added to the array elements. param[in] n The size of the input and output arrays. param[in] coef The multiplication factor that is applied to all calculated bin indices.

Implemented in RooRangeBinning, RooBinning, RooLinTransBinning, RooParamBinning, and RooUniformBinning.

◆ binWidth()

virtual double RooAbsBinning::binWidth ( Int_t  bin) const
pure virtual

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

static constexpr Version_t RooAbsBinning::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 125 of file RooAbsBinning.h.

◆ clone()

virtual RooAbsBinning * RooAbsBinning::clone ( const char *  name = nullptr) const
pure virtual

◆ Clone()

TObject * RooAbsBinning::Clone ( const char *  newname = nullptr) const
inlineoverridevirtual

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented from TObject.

Definition at line 32 of file RooAbsBinning.h.

◆ DeclFileName()

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

Definition at line 125 of file RooAbsBinning.h.

◆ highBound()

virtual double RooAbsBinning::highBound ( ) const
pure virtual

◆ highBoundFunc()

virtual RooAbsReal * RooAbsBinning::highBoundFunc ( ) const
inlinevirtual

Return pointer to RooAbsReal parameterized upper bound, if any.

Reimplemented in RooParamBinning.

Definition at line 110 of file RooAbsBinning.h.

◆ insertHook()

virtual void RooAbsBinning::insertHook ( RooAbsRealLValue ) const
inlinevirtual

Hook interface function to execute code upon insertion into a RooAbsRealLValue.

Reimplemented in RooParamBinning.

Definition at line 118 of file RooAbsBinning.h.

◆ IsA()

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

Reimplemented from TObject.

Reimplemented in RooBinning, RooLinTransBinning, RooParamBinning, RooRangeBinning, and RooUniformBinning.

Definition at line 125 of file RooAbsBinning.h.

◆ isParameterized()

virtual bool RooAbsBinning::isParameterized ( ) const
inlinevirtual

Interface function.

If true, min/max of binning is parameterized by external RooAbsReals. Default to false, unless overridden by a sub class.

Reimplemented in RooParamBinning.

Definition at line 102 of file RooAbsBinning.h.

◆ isShareable()

virtual bool RooAbsBinning::isShareable ( ) const
inlinevirtual

If true (default), the range definition can be shared across clones of a RooRealVar.

Reimplemented in RooParamBinning.

Definition at line 114 of file RooAbsBinning.h.

◆ isUniform()

virtual bool RooAbsBinning::isUniform ( ) const
inlinevirtual

Reimplemented in RooUniformBinning.

Definition at line 70 of file RooAbsBinning.h.

◆ lowBound()

virtual double RooAbsBinning::lowBound ( ) const
pure virtual

◆ lowBoundFunc()

virtual RooAbsReal * RooAbsBinning::lowBoundFunc ( ) const
inlinevirtual

Return pointer to RooAbsReal parameterized lower bound, if any.

Reimplemented in RooParamBinning.

Definition at line 106 of file RooAbsBinning.h.

◆ numBins()

Int_t RooAbsBinning::numBins ( ) const
inline

Return number of bins.

Definition at line 36 of file RooAbsBinning.h.

◆ numBoundaries()

virtual Int_t RooAbsBinning::numBoundaries ( ) const
pure virtual

◆ Print()

void RooAbsBinning::Print ( Option_t option = nullptr) const
inlineoverridevirtual

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

Reimplemented from TObject.

Definition at line 89 of file RooAbsBinning.h.

◆ printArgs()

void RooAbsBinning::printArgs ( std::ostream &  os) const
overridevirtual

Print binning arguments (the RooAbsReal objects represening the variable bin boundaries for parameterized binning implementations.

Reimplemented from RooPrintable.

Definition at line 74 of file RooAbsBinning.cxx.

◆ printClassName()

void RooAbsBinning::printClassName ( std::ostream &  os) const
overridevirtual

Print binning class name.

Reimplemented from RooPrintable.

Definition at line 63 of file RooAbsBinning.cxx.

◆ printName()

void RooAbsBinning::printName ( std::ostream &  os) const
overridevirtual

Print binning name.

Reimplemented from RooPrintable.

Definition at line 43 of file RooAbsBinning.cxx.

◆ printTitle()

void RooAbsBinning::printTitle ( std::ostream &  os) const
overridevirtual

Print binning title.

Reimplemented from RooPrintable.

Definition at line 53 of file RooAbsBinning.cxx.

◆ printValue()

void RooAbsBinning::printValue ( std::ostream &  os) const
overridevirtual

Print binning value, i.e the bin boundary positions.

Reimplemented from RooPrintable.

Definition at line 94 of file RooAbsBinning.cxx.

◆ removeHook()

virtual void RooAbsBinning::removeHook ( RooAbsRealLValue ) const
inlinevirtual

Hook interface function to execute code upon removal from a RooAbsRealLValue.

Reimplemented in RooParamBinning.

Definition at line 120 of file RooAbsBinning.h.

◆ setMax()

virtual void RooAbsBinning::setMax ( double  xhi)
inlinevirtual

Change upper bound to xhi.

Reimplemented in RooLinTransBinning, and RooRangeBinning.

Definition at line 78 of file RooAbsBinning.h.

◆ setMin()

virtual void RooAbsBinning::setMin ( double  xlo)
inlinevirtual

Change lower bound to xlo.

Reimplemented in RooLinTransBinning, and RooRangeBinning.

Definition at line 74 of file RooAbsBinning.h.

◆ setRange()

virtual void RooAbsBinning::setRange ( double  xlo,
double  xhi 
)
pure virtual

◆ Streamer()

void RooAbsBinning::Streamer ( TBuffer R__b)
overridevirtual

Custom streamer implementing schema evolution between V1 and V2 persistent binnings.

Reimplemented from TObject.

Reimplemented in RooBinning, RooLinTransBinning, RooParamBinning, RooRangeBinning, and RooUniformBinning.

Definition at line 116 of file RooAbsBinning.cxx.

◆ StreamerNVirtual()

void RooAbsBinning::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 125 of file RooAbsBinning.h.

Libraries for RooAbsBinning:

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