Implementation of RooAbsBinning that provides a uniform binning in 'n' bins between the range end points.

A RooUniformBinning is 'elastic': if the range changes the binning will change accordingly, unlike e.g. the binning of class RooBinning.

Definition at line 22 of file RooUniformBinning.h.

Public Member Functions
	RooUniformBinning (const char *name=nullptr)

	RooUniformBinning (const RooUniformBinning &other, const char *name=nullptr)
	Copy constructor.

	RooUniformBinning (double xlo, double xhi, Int_t nBins, const char *name=nullptr)
	Construct range [xlo,xhi] with 'nBins' bins.

double *	array () const override
	Return an array of doubles with the bin boundaries.

double	averageBinWidth () const override

double	binCenter (Int_t bin) const override
	Return the central value of the 'i'-th fit bin.

double	binHigh (Int_t bin) const override
	Return the high edge of the 'i'-th fit bin.

double	binLow (Int_t bin) const override
	Return the low edge of the 'i'-th fit bin.

void	binNumbers (double const x, int bins, std::size_t n, int coef) const override
	Return the index of the bin that encloses 'x'.

double	binWidth (Int_t bin) const override
	Return the bin width (same for all bins)

RooAbsBinning *	clone (const char *name=nullptr) const override

double	highBound () const override

TClass *	IsA () const override

bool	isUniform () const override

double	lowBound () const override

Int_t	numBoundaries () const override

void	setRange (double xlo, double xhi) override
	Change range to [xlo,xhi].

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 RooAbsBinning
	RooAbsBinning (const char *name=nullptr)

	RooAbsBinning (const RooAbsBinning &other, const char *name=nullptr)

int	binNumber (double x) const
	Returns the bin number corresponding to the value `x`.

TObject *	Clone (const char *newname=nullptr) const override
	Make a clone of an object using the Streamer facility.

virtual RooAbsReal *	highBoundFunc () 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.

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 RooAbsReal *	lowBoundFunc () const
	Return pointer to RooAbsReal parameterized lower bound, if any.

Int_t	numBins () const
	Return number of bins.

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.

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 ("").

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

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

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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)

TObject &	operator= (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 TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooAbsBinning
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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 TClass *	Class ()

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.

Protected Attributes
std::vector< double >	_array
	! do not persist

double	_binw

Int_t	_nbins

double	_xhi

double	_xlo

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 )) }

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

Static Protected Attributes inherited from RooPrintable
static Int_t	_nameLength

#include <RooUniformBinning.h>

Inheritance diagram for RooUniformBinning:

[legend]

Constructor & Destructor Documentation

◆ RooUniformBinning() [1/3]

RooUniformBinning::RooUniformBinning ( const char * name = nullptr )

inline

Definition at line 25 of file RooUniformBinning.h.

◆ RooUniformBinning() [2/3]

RooUniformBinning::RooUniformBinning	(	double	xlo,
		double	xhi,
		Int_t	nBins,
		const char *	name = `nullptr`
	)

Construct range [xlo,xhi] with 'nBins' bins.

Definition at line 41 of file RooUniformBinning.cxx.

◆ RooUniformBinning() [3/3]

RooUniformBinning::RooUniformBinning	(	const RooUniformBinning &	other,
		const char *	name = `nullptr`
	)

Copy constructor.

Definition at line 51 of file RooUniformBinning.cxx.

Member Function Documentation

◆ array()

double * RooUniformBinning::array ( ) const

overridevirtual

Return an array of doubles with the bin boundaries.

Implements RooAbsBinning.

Definition at line 155 of file RooUniformBinning.cxx.

◆ averageBinWidth()

double RooUniformBinning::averageBinWidth ( ) const

inlineoverridevirtual

Implements RooAbsBinning.

Definition at line 44 of file RooUniformBinning.h.

◆ binCenter()

double RooUniformBinning::binCenter ( Int_t bin ) const

overridevirtual

Return the central value of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 96 of file RooUniformBinning.cxx.

◆ binHigh()

double RooUniformBinning::binHigh ( Int_t bin ) const

overridevirtual

Return the high edge of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 139 of file RooUniformBinning.cxx.

◆ binLow()

double RooUniformBinning::binLow ( Int_t bin ) const

overridevirtual

Return the low edge of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 123 of file RooUniformBinning.cxx.

◆ binNumbers()

void RooUniformBinning::binNumbers	(	double const *	x,
		int *	bins,
		std::size_t	n,
		int	coef
	)		const

overridevirtual

Return the index of the bin that encloses 'x'.

Implements RooAbsBinning.

Definition at line 82 of file RooUniformBinning.cxx.

◆ binWidth()

double RooUniformBinning::binWidth ( Int_t bin ) const

overridevirtual

Return the bin width (same for all bins)

Implements RooAbsBinning.

Definition at line 113 of file RooUniformBinning.cxx.

◆ Class()

static TClass * RooUniformBinning::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooUniformBinning::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooUniformBinning::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 54 of file RooUniformBinning.h.

◆ clone()

RooAbsBinning * RooUniformBinning::clone ( const char * name = nullptr ) const

inlineoverridevirtual

Implements RooAbsBinning.

Definition at line 28 of file RooUniformBinning.h.

◆ DeclFileName()

static const char * RooUniformBinning::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 54 of file RooUniformBinning.h.

◆ highBound()

double RooUniformBinning::highBound ( ) const

inlineoverridevirtual

Implements RooAbsBinning.

Definition at line 37 of file RooUniformBinning.h.

◆ IsA()

TClass * RooUniformBinning::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from RooAbsBinning.

Definition at line 54 of file RooUniformBinning.h.

◆ isUniform()

bool RooUniformBinning::isUniform ( ) const

inlineoverridevirtual

Reimplemented from RooAbsBinning.

Definition at line 34 of file RooUniformBinning.h.

◆ lowBound()

double RooUniformBinning::lowBound ( ) const

inlineoverridevirtual

Implements RooAbsBinning.

Definition at line 36 of file RooUniformBinning.h.

◆ numBoundaries()

Int_t RooUniformBinning::numBoundaries ( ) const

inlineoverridevirtual

Implements RooAbsBinning.

Definition at line 32 of file RooUniformBinning.h.

◆ setRange()

void RooUniformBinning::setRange	(	double	xlo,
		double	xhi
	)

overridevirtual

Change range to [xlo,xhi].

A changes in range automatically adjusts the binning as well to nBins bins in the new range

Implements RooAbsBinning.

Definition at line 62 of file RooUniformBinning.cxx.

◆ Streamer()

void RooUniformBinning::Streamer ( TBuffer & R__b )

overridevirtual

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

Reimplemented from RooAbsBinning.

◆ StreamerNVirtual()

void RooUniformBinning::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 54 of file RooUniformBinning.h.

Member Data Documentation

◆ _array

std::vector<double> RooUniformBinning::_array

mutableprotected

! do not persist

Definition at line 48 of file RooUniformBinning.h.

◆ _binw

double RooUniformBinning::_binw

protected

Definition at line 52 of file RooUniformBinning.h.

◆ _nbins

Int_t RooUniformBinning::_nbins

protected

Definition at line 51 of file RooUniformBinning.h.

◆ _xhi

double RooUniformBinning::_xhi

protected

Definition at line 50 of file RooUniformBinning.h.

◆ _xlo

double RooUniformBinning::_xlo

protected

Definition at line 49 of file RooUniformBinning.h.

Libraries for RooUniformBinning:

[legend]

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

roofit/roofitcore/inc/RooUniformBinning.h
roofit/roofitcore/src/RooUniformBinning.cxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooUniformBinning() [1/3]

◆ RooUniformBinning() [2/3]

◆ RooUniformBinning() [3/3]

Member Function Documentation

◆ array()

◆ averageBinWidth()

◆ binCenter()

◆ binHigh()

◆ binLow()

◆ binNumbers()

◆ binWidth()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ clone()

◆ DeclFileName()

◆ highBound()

◆ IsA()

◆ isUniform()

◆ lowBound()

◆ numBoundaries()

◆ setRange()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ _array

◆ _binw

◆ _nbins

◆ _xhi

◆ _xlo