RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.

Collections are ordered and can contain multiple objects of the same name, (but a derived implementation can enforce unique names). The storage of objects is implemented using the container denoted by RooAbsCollection::Storage_t.

PyROOT

Some member functions of RooAbsCollection that take a RooCmdArg as argument also support keyword arguments. So far, this applies to RooAbsCollection::printLatex. For example, the following code is equivalent in PyROOT:

# Directly passing a RooCmdArg:
params.printLatex(ROOT.RooFit.Sibling(initParams), ROOT.RooFit.Columns(2))
 
# With keyword arguments:
params.printLatex(Sibling=initParams, Columns =2)

Definition at line 63 of file RooAbsCollection.h.

Classes
struct	RooAbsArgPtrOrDouble

Public Types
using	const_iterator = Storage_t::const_iterator

using	Storage_t = std::vector< RooAbsArg * >

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 }

Public Member Functions
	RooAbsCollection ()
	Default constructor.

	RooAbsCollection (const char *name)
	Empty collection constructor.

	RooAbsCollection (const RooAbsCollection &other, const char *name="")
	Copy constructor.

	RooAbsCollection (RooAbsCollection &&other)
	Move constructor.

	~RooAbsCollection () override
	Destructor.

virtual bool	add (const RooAbsArg &var, bool silent=false)
	Add the specified argument to list.

bool	add (const RooAbsCollection &list, bool silent=false)
	Add a collection of arguments to this collection by calling add() for each element in the source collection.

template<typename Iterator_t , typename value_type = typename std::remove_pointer<typename std::iterator_traits<Iterator_t>::value_type>, typename = std::enable_if<std::is_convertible<const value_type, const RooAbsArg>::value>>
bool	add (Iterator_t beginIt, Iterator_t endIt, bool silent=false)

virtual RooAbsArg *	addClone (const RooAbsArg &var, bool silent=false)
	Add a clone of the specified argument to list.

virtual void	addClone (const RooAbsCollection &list, bool silent=false)
	Add a collection of arguments to this collection by calling addOwned() for each element in the source collection.

virtual bool	addOwned (const RooAbsCollection &list, bool silent=false)
	for each element in the source collection.

virtual bool	addOwned (RooAbsArg &var, bool silent=false)
	Add an argument and transfer the ownership to the collection.

bool	addOwned (RooAbsCollection &&list, bool silent=false)
	Add a collection of arguments to this collection by calling addOwned() for each element in the source collection.

bool	addOwned (std::unique_ptr< RooAbsArg > var, bool silent=false)
	Add an argument and transfer the ownership to the collection from a `std::unique_ptr`.

bool	allInRange (const char *rangeSpec) const
	Return true if all contained object report to have their value inside the specified range.

void	assign (const RooAbsCollection &other) const
	Sets the value, cache and constant attribute of any argument in our set that also appears in the other set.

void	assignFast (const RooAbsCollection &other, bool setValDirty=true) const
	Functional equivalent of assign() but assumes this and other collection have same layout.

RooAbsCollection &	assignValueOnly (const RooAbsCollection &other, bool forceIfSizeOne=false)
	Sets the value of any argument in our set that also appears in the other set.

const_iterator	begin () const

void	clear ()
	Clear contents. If the collection is owning, it will also delete the contents.

virtual TObject *	clone (const char *newname) const =0

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

bool	contains (const RooAbsArg &var) const
	Check if collection contains an argument with the same name as var.

virtual bool	containsInstance (const RooAbsArg &var) const
	Check if this exact instance is in this collection.

std::string	contentsString () const
	Return comma separated list of contained object names as STL string.

virtual TObject *	create (const char *newname) const =0

TIterator *	createIterator (bool dir=kIterForward) const
	TIterator-style iteration over contained elements.

Int_t	defaultPrintContents (Option_t *opt) const override
	Define default RooPrinable print options for given Print() flag string For inline printing only show value of objects, for default print show name,class name value and extras of each object.

void	dump () const
	Base contents dumper for debugging purposes.

bool	empty () const

const_iterator	end () const

bool	equals (const RooAbsCollection &otherColl) const
	Check if this and other collection have identically-named contents.

RooAbsArg *	find (const char *name) const
	Find object with given name in list.

RooAbsArg *	find (const RooAbsArg &) const
	Find object with given name in list.

TObject *	FindObject (const char *name) const override
	Find object by name in the collection.

TObject *	FindObject (const TObject *obj) const override
	Find object in the collection, Note: matching by object name, like the find() method.

RooAbsArg *	first () const

RooFIter	fwdIterator () const
	One-time forward iterator.

Storage_t const &	get () const
	Const access to the underlying stl container.

Int_t	getCatIndex (const char *name, Int_t defVal=0, bool verbose=false) const
	Get index value of a RooAbsCategory stored in set with given name.

const char *	getCatLabel (const char name, const char defVal="", bool verbose=false) const
	Get state name of a RooAbsCategory stored in set with given name.

Int_t	getHashTableSize () const
	Query the size at which the collection will automatically start using an extra lookup table instead of performing a linear search.

const char *	GetName () const override
	Returns name of object.

double	getRealValue (const char *name, double defVal=0.0, bool verbose=false) const
	Get value of a RooAbsReal stored in set with given name.

Int_t	getSize () const
	Return the number of elements in the collection.

const char *	getStringValue (const char name, const char defVal="", bool verbose=false) const
	Get string value of a RooStringVar stored in set with given name.

bool	hasSameLayout (const RooAbsCollection &other) const
	Check that all entries where the collections overlap have the same name.

Int_t	index (const char *name) const
	Return index of item with given name, or -1 in case it's not in the collection.

Int_t	index (const RooAbsArg &arg) const
	Returns index of given arg, or -1 if arg is not in the collection.

Int_t	index (const RooAbsArg *arg) const
	Returns index of given arg, or -1 if arg is not in the collection.

TClass *	IsA () const override

bool	isOwning () const

RooLinkedListIter	iterator (bool dir=kIterForward) const
	TIterator-style iteration over contained elements.

RooAbsCollection &	operator= (const RooAbsCollection &other)
	Assign values from the elements in `other` to our elements.

RooAbsArg *	operator[] (Storage_t::size_type i) const

bool	overlaps (const RooAbsCollection &otherColl) const
	Check if this and other collection have common entries.

template<typename Iterator_t , typename value_type = typename std::remove_pointer<typename std::iterator_traits<Iterator_t>::value_type>, typename = std::enable_if<std::is_convertible<const value_type, const RooAbsArg>::value>>
bool	overlaps (Iterator_t otherCollBegin, Iterator_t otherCollEnd) const

void	Print (Option_t *options=nullptr) const override
	This method must be overridden when a class wants to print itself.

void	printClassName (std::ostream &os) const override
	Return collection class name.

void	printLatex (const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg()) const
	Output content of collection as LaTex table.

void	printLatex (std::ostream &ofs, Int_t ncol, const char option="NEYU", Int_t sigDigit=1, const RooLinkedList &siblingLists=RooLinkedList(), const RooCmdArg formatCmd=nullptr) const
	Internal implementation function of printLatex.

void	printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
	Implement multiline printing of collection, one line for each contained object showing the requested content.

void	printName (std::ostream &os) const override
	Return collection name.

void	printTitle (std::ostream &os) const override
	Return collection title.

void	printValue (std::ostream &os) const override
	Print value of collection, i.e.

Storage_t::const_reverse_iterator	rbegin () const

void	RecursiveRemove (TObject *obj) override
	If one of the TObject we have a referenced to is deleted, remove the reference.

void	releaseOwnership ()

virtual bool	remove (const RooAbsArg &var, bool silent=false, bool matchByNameOnly=false)
	Remove the specified argument from our list.

bool	remove (const RooAbsCollection &list, bool silent=false, bool matchByNameOnly=false)
	Remove each argument in the input list from our list.

template<class forwardIt >
void	remove (forwardIt rangeBegin, forwardIt rangeEnd, bool silent=false, bool matchByNameOnly=false)

virtual void	removeAll ()
	Remove all arguments from our set, deleting them if we own them.

Storage_t::const_reverse_iterator	rend () const

virtual bool	replace (const RooAbsArg &var1, const RooAbsArg &var2)
	Replace var1 with var2 and return true for success.

bool	replace (const RooAbsCollection &other)
	Replace any args in our set with args of the same name from the other set and return true for success.

void	reserve (Storage_t::size_type count)

RooAbsCollection *	selectByAttrib (const char *name, bool value) const
	Create a subset of the current collection, consisting only of those elements with the specified attribute set.

RooAbsCollection *	selectByName (const char *nameList, bool verbose=false) const
	Create a subset of the current collection, consisting only of those elements with names matching the wildcard expressions in nameList, supplied as a comma separated list.

RooAbsCollection *	selectCommon (const RooAbsCollection &refColl) const
	Create a subset of the current collection, consisting only of those elements that are contained as well in the given reference collection.

bool	selectCommon (const RooAbsCollection &refColl, RooAbsCollection &outColl) const
	Create a subset of the current collection, consisting only of those elements that are contained as well in the given reference collection.

void	setAttribAll (const Text_t *name, bool value=true)
	Set given attribute in each element of the collection by calling each elements setAttribute() function.

bool	setCatIndex (const char *name, Int_t newVal=0, bool verbose=false)
	Set index value of a RooAbsCategoryLValue stored in set with given name to newVal.

bool	setCatLabel (const char name, const char newVal="", bool verbose=false)
	Set state name of a RooAbsCategoryLValue stored in set with given name to newVal.

void	setHashTableSize (Int_t number)
	Set the size at which the collection will automatically start using an extra lookup table instead of performing a linear search.

void	setName (const char *name)

bool	setRealValue (const char *name, double newVal=0.0, bool verbose=false)
	Set value of a RooAbsRealLValye stored in set with given name to newVal No error messages are printed unless the verbose flag is set.

bool	setStringValue (const char name, const char newVal="", bool verbose=false)
	Set string value of a RooStringVar stored in set with given name to newVal.

Storage_t::size_type	size () const

RooAbsCollection *	snapshot (bool deepCopy=true) const
	Take a snap shot of current collection contents.

bool	snapshot (RooAbsCollection &output, bool deepCopy=true) const
	Take a snap shot of current collection contents: A collection that owns its elements is returned containing clones of.

void	sort (bool reverse=false)
	Sort collection using std::sort and name comparison.

void	sortTopologically ()
	Sort collection topologically: the servers of any RooAbsArg will be before that RooAbsArg in the collection.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	takeOwnership ()

RooFit::UniqueId< RooAbsCollection > const &	uniqueId () const
	Returns a unique ID that is different for every instantiated RooAbsCollection.

void	useHashMapForFind (bool flag) const

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	Clear (Option_t *="")

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

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

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.

virtual ULong_t	Hash () const
	Return hash value for this object.

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

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.

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.

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.

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 StyleOption	defaultPrintStyle (Option_t *opt) const

virtual void	printAddress (std::ostream &os) const
	Print class name of object.

virtual void	printArgs (std::ostream &os) const
	Interface for printing of object arguments.

virtual void	printExtras (std::ostream &os) const
	Interface to print extras 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 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 Types
using	LegacyIterator_t = TIteratorToSTLInterface< Storage_t >

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions
bool	addServerClonesToList (const RooAbsArg &var)
	Add clones of servers of given argument to end of list.

virtual bool	canBeAdded (const RooAbsArg &arg, bool silent) const =0
	Determine whether it's possible to add a given RooAbsArg to the collection or not.

void	clearStructureTags ()

void	deleteList ()
	Delete contents of the list.

void	makeStructureTag ()

void	makeTypedStructureTag ()

TNamed *	structureTag ()

TNamed *	typedStructureTag ()

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 Member Functions
template<class T >
static void	assert_is_no_temporary (T &&)

Protected Attributes
bool	_allRRV = true
	All contents are RRV.

Storage_t	_list
	Actual object storage.

TString	_name
	Our name.

bool	_ownCont = false
	Flag to identify a list that owns its contents.

TNamed *	_structureTag {nullptr}
	! Structure tag

TNamed *	_typedStructureTag {nullptr}
	! Typed structure tag

Private Types
using	HashAssistedFind = RooFit::Detail::HashAssistedFind

Private Member Functions
void	insert (RooAbsArg *)
	Insert an element into the owned collections.

std::unique_ptr< LegacyIterator_t >	makeLegacyIterator (bool forward=true) const
	Factory for legacy iterators.

Private Attributes
std::unique_ptr< HashAssistedFind >	_hashAssistedFind
	!

std::size_t	_sizeThresholdForMapSearch = 100
	!

const RooFit::UniqueId< RooAbsCollection >	_uniqueId

Additional Inherited Members
Static Protected Attributes inherited from RooPrintable
static Int_t	_nameLength

#include <RooAbsCollection.h>

Inheritance diagram for RooAbsCollection:

[legend]

Member Typedef Documentation

◆ const_iterator

using RooAbsCollection::const_iterator = Storage_t::const_iterator

Definition at line 66 of file RooAbsCollection.h.

◆ HashAssistedFind

using RooAbsCollection::HashAssistedFind = RooFit::Detail::HashAssistedFind

private

Definition at line 409 of file RooAbsCollection.h.

◆ LegacyIterator_t

using RooAbsCollection::LegacyIterator_t = TIteratorToSTLInterface<Storage_t>

protected

Definition at line 372 of file RooAbsCollection.h.

◆ Storage_t

using RooAbsCollection::Storage_t = std::vector<RooAbsArg*>

Definition at line 65 of file RooAbsCollection.h.

Constructor & Destructor Documentation

◆ RooAbsCollection() [1/4]

RooAbsCollection::RooAbsCollection ( )

Default constructor.

Definition at line 117 of file RooAbsCollection.cxx.

◆ RooAbsCollection() [2/4]

RooAbsCollection::RooAbsCollection ( const char * name )

Empty collection constructor.

Definition at line 127 of file RooAbsCollection.cxx.

◆ ~RooAbsCollection()

RooAbsCollection::~RooAbsCollection ( )

override

Destructor.

Definition at line 176 of file RooAbsCollection.cxx.

◆ RooAbsCollection() [3/4]

RooAbsCollection::RooAbsCollection	(	const RooAbsCollection &	other,
		const char *	name = `""`
	)

Copy constructor.

Note that a copy of a collection is always non-owning, even the source collection is owning. To create an owning copy of a collection (owning or not), use the snapshot() method.

Definition at line 140 of file RooAbsCollection.cxx.

◆ RooAbsCollection() [4/4]

RooAbsCollection::RooAbsCollection ( RooAbsCollection && other )

Move constructor.

Definition at line 161 of file RooAbsCollection.cxx.

Member Function Documentation

◆ add() [1/3]

bool RooAbsCollection::add	(	const RooAbsArg &	var,
		bool	silent = `false`
	)

virtual

Add the specified argument to list.

Returns true if successful, or else false if a variable of the same name is already in the list or the list owns its variables (in this case, try addClone() or addOwned() instead).

Reimplemented in RooCollectionProxy< RooArgList >, RooCollectionProxy< RooArgSet >, RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 498 of file RooAbsCollection.cxx.

◆ add() [2/3]

bool RooAbsCollection::add	(	const RooAbsCollection &	list,
		bool	silent = `false`
	)

inline

Add a collection of arguments to this collection by calling add() for each element in the source collection.

Definition at line 148 of file RooAbsCollection.h.

◆ add() [3/3]

template<typename Iterator_t , typename value_type = typename std::remove_pointer<typename std::iterator_traits<Iterator_t>::value_type>, typename = std::enable_if<std::is_convertible<const value_type*, const RooAbsArg*>::value>>

bool RooAbsCollection::add	(	Iterator_t	beginIt,
		Iterator_t	endIt,
		bool	silent = `false`
	)

inline

Definition at line 137 of file RooAbsCollection.h.

◆ addClone() [1/2]

RooAbsArg * RooAbsCollection::addClone	(	const RooAbsArg &	var,
		bool	silent = `false`
	)

virtual

Add a clone of the specified argument to list.

Returns a pointer to the clone if successful, or else zero if a variable of the same name is already in the list or the list does not own its variables (in this case, try add() instead.) Calling addClone() on an empty list forces it to take ownership of all its subsequent variables.

Reimplemented in RooCollectionProxy< RooArgList >, RooCollectionProxy< RooArgSet >, RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 471 of file RooAbsCollection.cxx.

◆ addClone() [2/2]

void RooAbsCollection::addClone	(	const RooAbsCollection &	list,
		bool	silent = `false`
	)

virtual

Add a collection of arguments to this collection by calling addOwned() for each element in the source collection.

Reimplemented in RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 584 of file RooAbsCollection.cxx.

◆ addOwned() [1/4]

bool RooAbsCollection::addOwned	(	const RooAbsCollection &	list,
		bool	silent = `false`
	)

virtual

for each element in the source collection.

The input list can't be an owning collection itself, otherwise the arguments would be owned by two collections.

If you want to transfer arguments from one owning collection to another, you have two options:

std::move the input collection and use RooAbsCollection::addOwned(RooAbsCollection&&, bool) (preferred)
release the ownership of the input collection first, using RooAbsCollection::releaseOwnership()

Reimplemented in RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 528 of file RooAbsCollection.cxx.

◆ addOwned() [2/4]

bool RooAbsCollection::addOwned	(	RooAbsArg &	var,
		bool	silent = `false`
	)

virtual

Add an argument and transfer the ownership to the collection.

Returns true if successful, or false if the argument could not be added to the collection (e.g. in the RooArgSet case when an argument with the same name is already in the list). This method can only be called on a list that is flagged as owning all of its contents, or else on an empty list (which will force the list into that mode).

If the argument you want to add is owned by a std::unique_ptr, you should prefer RooAbsCollection::addOwned(std::unique_ptr<RooAbsArg>, bool).

Reimplemented in RooCollectionProxy< RooArgList >, RooCollectionProxy< RooArgSet >, RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 424 of file RooAbsCollection.cxx.

◆ addOwned() [3/4]

bool RooAbsCollection::addOwned	(	RooAbsCollection &&	list,
		bool	silent = `false`
	)

Add a collection of arguments to this collection by calling addOwned() for each element in the source collection.

Unlike RooAbsCollection::addOwned(const RooAbsCollection&, bool), this function also accepts owning source collections because their content will be moved out.

Definition at line 556 of file RooAbsCollection.cxx.

◆ addOwned() [4/4]

bool RooAbsCollection::addOwned	(	std::unique_ptr< RooAbsArg >	var,
		bool	silent = `false`
	)

Add an argument and transfer the ownership to the collection from a std::unique_ptr.

Always returns true. If the argument can not be added to the collection (e.g. in the RooArgSet case when an argument with the same name is already in the list), a std::runtime_exception will be thrown, as nobody is owning the argument anymore. This method can only be called on a list that is flagged as owning all of its contents, or else on an empty list (which will force the list into that mode).

If you want to pass an argument that is not owned by a std::unique_ptr, you can use RooAbsCollection::addOwned(RooAbsArg&, bool).

Definition at line 453 of file RooAbsCollection.cxx.

◆ addServerClonesToList()

bool RooAbsCollection::addServerClonesToList ( const RooAbsArg & var )

protected

Add clones of servers of given argument to end of list.

Definition at line 298 of file RooAbsCollection.cxx.

◆ allInRange()

bool RooAbsCollection::allInRange ( const char * rangeSpec ) const

Return true if all contained object report to have their value inside the specified range.

Definition at line 1496 of file RooAbsCollection.cxx.

◆ assert_is_no_temporary()

template<class T >

static void RooAbsCollection::assert_is_no_temporary ( T && )

inlinestaticprotected

Definition at line 398 of file RooAbsCollection.h.

◆ assign()

void RooAbsCollection::assign ( const RooAbsCollection & other ) const

Sets the value, cache and constant attribute of any argument in our set that also appears in the other set.

Note that this function changes the values of the elements in this collection, but is still marked const as it does not change which elements this collection points to.

Definition at line 340 of file RooAbsCollection.cxx.

◆ assignFast()

void RooAbsCollection::assignFast	(	const RooAbsCollection &	other,
		bool	setValDirty = `true`
	)		const

Functional equivalent of assign() but assumes this and other collection have same layout.

Also no attributes are copied

Definition at line 388 of file RooAbsCollection.cxx.

◆ assignValueOnly()

RooAbsCollection & RooAbsCollection::assignValueOnly	(	const RooAbsCollection &	other,
		bool	forceIfSizeOne = `false`
	)

Sets the value of any argument in our set that also appears in the other set.

Parameters

[in]	other	Collection holding the arguments to syncronize values with.
[in]	forceIfSizeOne	If set to true and both our collection and the other collection have a size of one, the arguments are always syncronized without checking if they have the same name.

Definition at line 362 of file RooAbsCollection.cxx.

◆ begin()

const_iterator RooAbsCollection::begin ( ) const

inline

Definition at line 247 of file RooAbsCollection.h.

◆ canBeAdded()

virtual bool RooAbsCollection::canBeAdded	(	const RooAbsArg &	arg,
		bool	silent
	)		const

protectedpure virtual

Determine whether it's possible to add a given RooAbsArg to the collection or not.

Implemented in RooArgSet, and RooArgList.

◆ Class()

static TClass * RooAbsCollection::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooAbsCollection::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooAbsCollection::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 417 of file RooAbsCollection.h.

◆ clear()

void RooAbsCollection::clear ( )

inline

Clear contents. If the collection is owning, it will also delete the contents.

Definition at line 276 of file RooAbsCollection.h.

◆ clearStructureTags()

void RooAbsCollection::clearStructureTags ( )

inlineprotected

Definition at line 389 of file RooAbsCollection.h.

◆ clone()

virtual TObject * RooAbsCollection::clone ( const char * newname ) const

pure virtual

Implemented in RooArgList, and RooArgSet.

◆ Clone()

TObject * RooAbsCollection::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 74 of file RooAbsCollection.h.

◆ contains()

bool RooAbsCollection::contains ( const RooAbsArg & var ) const

inline

Check if collection contains an argument with the same name as var.

To check for a specific instance, use containsInstance().

Definition at line 192 of file RooAbsCollection.h.

◆ containsInstance()

virtual bool RooAbsCollection::containsInstance ( const RooAbsArg & var ) const

inlinevirtual

Check if this exact instance is in this collection.

Reimplemented in RooArgSet.

Definition at line 196 of file RooAbsCollection.h.

◆ contentsString()

std::string RooAbsCollection::contentsString ( ) const

Return comma separated list of contained object names as STL string.

Definition at line 1163 of file RooAbsCollection.cxx.

◆ create()

virtual TObject * RooAbsCollection::create ( const char * newname ) const

pure virtual

Implemented in RooArgList, and RooArgSet.

◆ createIterator()

TIterator * RooAbsCollection::createIterator ( bool dir = kIterForward ) const

inline

TIterator-style iteration over contained elements.

Note: These iterators are slow. Use begin() and end() or range-based for loop instead.

Definition at line 227 of file RooAbsCollection.h.

◆ DeclFileName()

static const char * RooAbsCollection::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 417 of file RooAbsCollection.h.

◆ defaultPrintContents()

Int_t RooAbsCollection::defaultPrintContents ( Option_t * opt ) const

overridevirtual

Define default RooPrinable print options for given Print() flag string For inline printing only show value of objects, for default print show name,class name value and extras of each object.

In verbose mode also add object adress, argument and title

Reimplemented from RooPrintable.

Definition at line 1214 of file RooAbsCollection.cxx.

◆ deleteList()

void RooAbsCollection::deleteList ( )

protected

Delete contents of the list.

The RooAbsArg destructor ensures clients and servers can be deleted in any order. Also cleans the hash-map for fast lookups if present.

Definition at line 191 of file RooAbsCollection.cxx.

◆ dump()

void RooAbsCollection::dump ( ) const

Base contents dumper for debugging purposes.

Definition at line 1293 of file RooAbsCollection.cxx.

◆ empty()

bool RooAbsCollection::empty ( ) const

inline

Definition at line 267 of file RooAbsCollection.h.

◆ end()

const_iterator RooAbsCollection::end ( ) const

inline

Definition at line 251 of file RooAbsCollection.h.

◆ equals()

bool RooAbsCollection::equals ( const RooAbsCollection & otherColl ) const

Check if this and other collection have identically-named contents.

Definition at line 902 of file RooAbsCollection.cxx.

◆ find() [1/2]

RooAbsArg * RooAbsCollection::find ( const char * name ) const

Find object with given name in list.

A null pointer is returned if no object with the given name is found.

Definition at line 937 of file RooAbsCollection.cxx.

◆ find() [2/2]

RooAbsArg * RooAbsCollection::find ( const RooAbsArg & arg ) const

Find object with given name in list.

A null pointer is returned if no object with the given name is found.

Definition at line 962 of file RooAbsCollection.cxx.

◆ FindObject() [1/2]

TObject * RooAbsCollection::FindObject ( const char * name ) const

inlineoverridevirtual

Find object by name in the collection.

Reimplemented from TObject.

Definition at line 185 of file RooAbsCollection.h.

◆ FindObject() [2/2]

TObject * RooAbsCollection::FindObject ( const TObject * obj ) const

inlineoverridevirtual

Find object in the collection, Note: matching by object name, like the find() method.

Reimplemented from TObject.

Definition at line 188 of file RooAbsCollection.h.

◆ first()

RooAbsArg * RooAbsCollection::first ( ) const

inline

Definition at line 285 of file RooAbsCollection.h.

◆ fwdIterator()

RooFIter RooAbsCollection::fwdIterator ( ) const

inline

One-time forward iterator.

Note: Use begin() and end() or range-based for loop instead.

Definition at line 242 of file RooAbsCollection.h.

◆ get()

Storage_t const & RooAbsCollection::get ( ) const

inline

Const access to the underlying stl container.

Definition at line 114 of file RooAbsCollection.h.

◆ getCatIndex()

Int_t RooAbsCollection::getCatIndex	(	const char *	name,
		Int_t	defVal = `0`,
		bool	verbose = `false`
	)		const

Get index value of a RooAbsCategory stored in set with given name.

If none is found, value of defVal is returned. No error messages are printed unless the verbose flag is set

Definition at line 1079 of file RooAbsCollection.cxx.

◆ getCatLabel()

const char * RooAbsCollection::getCatLabel	(	const char *	name,
		const char *	defVal = `""`,
		bool	verbose = `false`
	)		const

Get state name of a RooAbsCategory stored in set with given name.

If none is found, value of defVal is returned. No error messages are printed unless the verbose flag is set

Definition at line 1036 of file RooAbsCollection.cxx.

◆ getHashTableSize()

Int_t RooAbsCollection::getHashTableSize ( ) const

inline

Query the size at which the collection will automatically start using an extra lookup table instead of performing a linear search.

Definition at line 109 of file RooAbsCollection.h.

◆ GetName()

const char * RooAbsCollection::GetName ( ) const

inlineoverridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 336 of file RooAbsCollection.h.

◆ getRealValue()

double RooAbsCollection::getRealValue	(	const char *	name,
		double	defVal = `0.0`,
		bool	verbose = `false`
	)		const

Get value of a RooAbsReal stored in set with given name.

If none is found, value of defVal is returned. No error messages are printed unless the verbose flag is set

Definition at line 993 of file RooAbsCollection.cxx.

◆ getSize()

Int_t RooAbsCollection::getSize ( ) const

inline

Return the number of elements in the collection.

Definition at line 281 of file RooAbsCollection.h.

◆ getStringValue()

const char * RooAbsCollection::getStringValue	(	const char *	name,
		const char *	defVal = `""`,
		bool	verbose = `false`
	)		const

Get string value of a RooStringVar stored in set with given name.

If none is found, value of defVal is returned. No error messages are printed unless the verbose flag is set

Definition at line 1122 of file RooAbsCollection.cxx.

◆ hasSameLayout()

bool RooAbsCollection::hasSameLayout ( const RooAbsCollection & other ) const

Check that all entries where the collections overlap have the same name.

Definition at line 1634 of file RooAbsCollection.cxx.

◆ index() [1/3]

Int_t RooAbsCollection::index ( const char * name ) const

Return index of item with given name, or -1 in case it's not in the collection.

Definition at line 980 of file RooAbsCollection.cxx.

◆ index() [2/3]

Int_t RooAbsCollection::index ( const RooAbsArg & arg ) const

inline

Returns index of given arg, or -1 if arg is not in the collection.

Definition at line 303 of file RooAbsCollection.h.

◆ index() [3/3]

Int_t RooAbsCollection::index ( const RooAbsArg * arg ) const

inline

Returns index of given arg, or -1 if arg is not in the collection.

Definition at line 297 of file RooAbsCollection.h.

◆ insert()

void RooAbsCollection::insert ( RooAbsArg * item )

private

Insert an element into the owned collections.

Definition at line 1611 of file RooAbsCollection.cxx.

◆ IsA()

TClass * RooAbsCollection::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in RooArgList, RooArgSet, RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 417 of file RooAbsCollection.h.

◆ isOwning()

bool RooAbsCollection::isOwning ( ) const

inline

Definition at line 340 of file RooAbsCollection.h.

◆ iterator()

RooLinkedListIter RooAbsCollection::iterator ( bool dir = kIterForward ) const

inline

TIterator-style iteration over contained elements.

Note: This iterator is slow. Use begin() and end() or range-based for loop instead.

Definition at line 235 of file RooAbsCollection.h.

◆ makeLegacyIterator()

std::unique_ptr< RooAbsCollection::LegacyIterator_t > RooAbsCollection::makeLegacyIterator ( bool forward = true ) const

private

Factory for legacy iterators.

Definition at line 1601 of file RooAbsCollection.cxx.

◆ makeStructureTag()

void RooAbsCollection::makeStructureTag ( )

inlineprotected

Definition at line 391 of file RooAbsCollection.h.

◆ makeTypedStructureTag()

void RooAbsCollection::makeTypedStructureTag ( )

inlineprotected

Definition at line 392 of file RooAbsCollection.h.

◆ operator=()

RooAbsCollection & RooAbsCollection::operator= ( const RooAbsCollection & other )

Assign values from the elements in other to our elements.

Warning: This is not a conventional assignment operator. To avoid confusion, prefer using RooAbsCollection::assign().

Definition at line 327 of file RooAbsCollection.cxx.

◆ operator[]()

RooAbsArg * RooAbsCollection::operator[] ( Storage_t::size_type i ) const

inline

Definition at line 291 of file RooAbsCollection.h.

◆ overlaps() [1/2]

bool RooAbsCollection::overlaps ( const RooAbsCollection & otherColl ) const

inline

Check if this and other collection have common entries.

Definition at line 220 of file RooAbsCollection.h.

◆ overlaps() [2/2]

template<typename Iterator_t , typename value_type = typename std::remove_pointer<typename std::iterator_traits<Iterator_t>::value_type>, typename = std::enable_if<std::is_convertible<const value_type*, const RooAbsArg*>::value>>

bool RooAbsCollection::overlaps	(	Iterator_t	otherCollBegin,
		Iterator_t	otherCollEnd
	)		const

inline

Definition at line 209 of file RooAbsCollection.h.

◆ Print()

void RooAbsCollection::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 309 of file RooAbsCollection.h.

◆ printClassName()

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

overridevirtual

Return collection class name.

Reimplemented from RooPrintable.

Definition at line 1201 of file RooAbsCollection.cxx.

◆ printLatex() [1/2]

RooAbsCollection::printLatex	(	const RooCmdArg &	arg1 = `RooCmdArg()`,
		const RooCmdArg &	arg2 = `RooCmdArg()`,
		const RooCmdArg &	arg3 = `RooCmdArg()`,
		const RooCmdArg &	arg4 = `RooCmdArg()`,
		const RooCmdArg &	arg5 = `RooCmdArg()`,
		const RooCmdArg &	arg6 = `RooCmdArg()`,
		const RooCmdArg &	arg7 = `RooCmdArg()`,
		const RooCmdArg &	arg8 = `RooCmdArg()`
	)		const

Output content of collection as LaTex table.

By default a table with two columns is created: the left column contains the name of each variable, the right column the value.

The following optional named arguments can be used to modify the default behavior

Argument Effect

Columns(Int_t ncol) Fold table into multiple columns, i.e. ncol=3 will result in 3 x 2 = 6 total columns

Sibling(const RooAbsCollection& other) Define sibling list. The sibling list is assumed to have objects with the same name in the same order. If this is not the case warnings will be printed. If a single sibling list is specified, 3 columns will be output: the (common) name, the value of this list and the value in the sibling list. Multiple sibling lists can be specified by repeating the Sibling() command.

Format(const char* str) Classic format string, provided for backward compatibility

Format()

Formatting arguments.

const char* what	Controls what is shown. "N" adds name, "E" adds error, "A" shows asymmetric error, "U" shows unit, "H" hides the value
`FixedPrecision(int n)`	Controls precision, set fixed number of digits
`AutoPrecision(int n)`	Controls precision. Number of shown digits is calculated from error and n specified additional digits (1 is sensible default)
`VerbatimName(bool flag)`	Put variable name in a \verb+ + clause.

OutputFile(const char* fname)

Send output to file with given name rather than standard output

Example use:

list.printLatex(Columns(2), Format("NEU",AutoPrecision(1),VerbatimName()) );

Format

static char * Format(const char *format, va_list ap)

Format a string in a circular formatting buffer (using a printf style format descriptor).

Definition TString.cxx:2420

PyROOT

The RooAbsCollection::printLatex() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Definition at line 1335 of file RooAbsCollection.cxx.

◆ printLatex() [2/2]

void RooAbsCollection::printLatex	(	std::ostream &	ofs,
		Int_t	ncol,
		const char *	option = `"NEYU"`,
		Int_t	sigDigit = `1`,
		const RooLinkedList &	siblingLists = `RooLinkedList()`,
		const RooCmdArg *	formatCmd = `nullptr`
	)		const

Internal implementation function of printLatex.

Definition at line 1392 of file RooAbsCollection.cxx.

◆ printMultiline()

void RooAbsCollection::printMultiline	(	std::ostream &	os,
		Int_t	contents,
		bool	verbose = `false`,
		TString	indent = `""`
	)		const

overridevirtual

Implement multiline printing of collection, one line for each contained object showing the requested content.

Reimplemented from RooPrintable.

Definition at line 1258 of file RooAbsCollection.cxx.

◆ printName()

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

overridevirtual

Return collection name.

Reimplemented from RooPrintable.

Definition at line 1181 of file RooAbsCollection.cxx.

◆ printTitle()

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

overridevirtual

Return collection title.

Reimplemented from RooPrintable.

Definition at line 1191 of file RooAbsCollection.cxx.

◆ printValue()

void RooAbsCollection::printValue ( std::ostream & os ) const

overridevirtual

Print value of collection, i.e.

a comma separated list of contained object names

Reimplemented from RooPrintable.

Definition at line 1233 of file RooAbsCollection.cxx.

◆ rbegin()

Storage_t::const_reverse_iterator RooAbsCollection::rbegin ( ) const

inline

Definition at line 255 of file RooAbsCollection.h.

◆ RecursiveRemove()

void RooAbsCollection::RecursiveRemove ( TObject * obj )

overridevirtual

If one of the TObject we have a referenced to is deleted, remove the reference.

Reimplemented from TObject.

Definition at line 1541 of file RooAbsCollection.cxx.

◆ releaseOwnership()

void RooAbsCollection::releaseOwnership ( )

inline

Definition at line 349 of file RooAbsCollection.h.

◆ remove() [1/3]

bool RooAbsCollection::remove	(	const RooAbsArg &	var,
		bool	silent = `false`,
		bool	matchByNameOnly = `false`
	)

virtual

Remove the specified argument from our list.

Return false if the specified argument is not found in our list. An exact pointer match is required, not just a match by name. If matchByNameOnly is set, items will be looked up by name. In this case, if the collection also owns the item, it will delete it.

Reimplemented in RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 674 of file RooAbsCollection.cxx.

◆ remove() [2/3]

bool RooAbsCollection::remove	(	const RooAbsCollection &	list,
		bool	silent = `false`,
		bool	matchByNameOnly = `false`
	)

Remove each argument in the input list from our list.

An exact pointer match is required, not just a match by name. If matchByNameOnly is set, items will be looked up by name. In this case, if the collection also owns the items, it will delete them. Return false in case of problems.

Definition at line 718 of file RooAbsCollection.cxx.

◆ remove() [3/3]

template<class forwardIt >

void RooAbsCollection::remove	(	forwardIt	rangeBegin,
		forwardIt	rangeEnd,
		bool	silent = `false`,
		bool	matchByNameOnly = `false`
	)

inline

Definition at line 157 of file RooAbsCollection.h.

◆ removeAll()

void RooAbsCollection::removeAll ( )

virtual

Remove all arguments from our set, deleting them if we own them.

This effectively restores our object to the state it would have just after calling the RooAbsCollection(const char*) constructor.

Reimplemented in RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 774 of file RooAbsCollection.cxx.

◆ rend()

Storage_t::const_reverse_iterator RooAbsCollection::rend ( ) const

inline

Definition at line 259 of file RooAbsCollection.h.

◆ replace() [1/2]

bool RooAbsCollection::replace	(	const RooAbsArg &	var1,
		const RooAbsArg &	var2
	)

virtual

Replace var1 with var2 and return true for success.

Fails if this list is a copy of another, if var1 is not already in this set, or if var2 is already in this set. var1 and var2 do not need to have the same name.

Reimplemented in RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

Definition at line 624 of file RooAbsCollection.cxx.

◆ replace() [2/2]

bool RooAbsCollection::replace ( const RooAbsCollection & other )

Replace any args in our set with args of the same name from the other set and return true for success.

Fails if this list is a copy of another.

Definition at line 599 of file RooAbsCollection.cxx.

◆ reserve()

void RooAbsCollection::reserve ( Storage_t::size_type count )

inline

Definition at line 271 of file RooAbsCollection.h.

◆ selectByAttrib()

RooAbsCollection * RooAbsCollection::selectByAttrib	(	const char *	name,
		bool	value
	)		const

Create a subset of the current collection, consisting only of those elements with the specified attribute set.

The caller is responsibe for deleting the returned collection

Definition at line 808 of file RooAbsCollection.cxx.

◆ selectByName()

RooAbsCollection * RooAbsCollection::selectByName	(	const char *	nameList,
		bool	verbose = `false`
	)		const

Create a subset of the current collection, consisting only of those elements with names matching the wildcard expressions in nameList, supplied as a comma separated list.

Definition at line 865 of file RooAbsCollection.cxx.

◆ selectCommon() [1/2]

RooAbsCollection * RooAbsCollection::selectCommon ( const RooAbsCollection & refColl ) const

Create a subset of the current collection, consisting only of those elements that are contained as well in the given reference collection.

The caller is responsible for deleting the returned collection

Definition at line 852 of file RooAbsCollection.cxx.

◆ selectCommon() [2/2]

bool RooAbsCollection::selectCommon	(	const RooAbsCollection &	refColl,
		RooAbsCollection &	outColl
	)		const

Create a subset of the current collection, consisting only of those elements that are contained as well in the given reference collection.

Returns true only if something went wrong. The complement of this function is getParameters().

Parameters

[in]	refColl	The collection to check for common elements.
[out]	outColl	Output collection.

Definition at line 832 of file RooAbsCollection.cxx.

◆ setAttribAll()

void RooAbsCollection::setAttribAll	(	const Text_t *	name,
		bool	value = `true`
	)

Set given attribute in each element of the collection by calling each elements setAttribute() function.

Definition at line 793 of file RooAbsCollection.cxx.

◆ setCatIndex()

bool RooAbsCollection::setCatIndex	(	const char *	name,
		Int_t	newVal = `0`,
		bool	verbose = `false`
	)

Set index value of a RooAbsCategoryLValue stored in set with given name to newVal.

No error messages are printed unless the verbose flag is set

Definition at line 1100 of file RooAbsCollection.cxx.

◆ setCatLabel()

bool RooAbsCollection::setCatLabel	(	const char *	name,
		const char *	newVal = `""`,
		bool	verbose = `false`
	)

Set state name of a RooAbsCategoryLValue stored in set with given name to newVal.

No error messages are printed unless the verbose flag is set

Definition at line 1057 of file RooAbsCollection.cxx.

◆ setHashTableSize()

void RooAbsCollection::setHashTableSize ( Int_t number )

inline

Set the size at which the collection will automatically start using an extra lookup table instead of performing a linear search.

Definition at line 104 of file RooAbsCollection.h.

◆ setName()

void RooAbsCollection::setName ( const char * name )

inline

Definition at line 332 of file RooAbsCollection.h.

◆ setRealValue()

bool RooAbsCollection::setRealValue	(	const char *	name,
		double	newVal = `0.0`,
		bool	verbose = `false`
	)

Set value of a RooAbsRealLValye stored in set with given name to newVal No error messages are printed unless the verbose flag is set.

Definition at line 1014 of file RooAbsCollection.cxx.

◆ setStringValue()

bool RooAbsCollection::setStringValue	(	const char *	name,
		const char *	newVal = `""`,
		bool	verbose = `false`
	)

Set string value of a RooStringVar stored in set with given name to newVal.

No error messages are printed unless the verbose flag is set

Definition at line 1144 of file RooAbsCollection.cxx.

◆ size()

Storage_t::size_type RooAbsCollection::size ( ) const

inline

Definition at line 263 of file RooAbsCollection.h.

◆ snapshot() [1/2]

RooAbsCollection * RooAbsCollection::snapshot ( bool deepCopy = true ) const

Take a snap shot of current collection contents.

An owning collection is returned containing clones of

Elements in this collection
External dependents of all elements and recursively any dependents of those dependents (if deepCopy flag is set)

This is useful to save the values of variables or parameters. It doesn't require deep copying if the parameters are direct members of the collection.

If deepCopy is specified, the client-server links between the cloned list elements and the cloned external dependents are reconnected to each other, making the snapshot a completely self-contained entity.

Definition at line 220 of file RooAbsCollection.cxx.

◆ snapshot() [2/2]

bool RooAbsCollection::snapshot	(	RooAbsCollection &	output,
		bool	deepCopy = `true`
	)		const

Take a snap shot of current collection contents: A collection that owns its elements is returned containing clones of.

Elements in this collection
External dependents of those elements and recursively any dependents of those dependents (if deepCopy flag is set)

If deepCopy is specified, the client-server links between the cloned list elements and the cloned external dependents are reconnected to each other, making the snapshot a completely self-contained entity.

Definition at line 254 of file RooAbsCollection.cxx.

◆ sort()

void RooAbsCollection::sort ( bool reverse = false )

Sort collection using std::sort and name comparison.

Definition at line 1549 of file RooAbsCollection.cxx.

◆ sortTopologically()

void RooAbsCollection::sortTopologically ( )

Sort collection topologically: the servers of any RooAbsArg will be before that RooAbsArg in the collection.

Definition at line 1573 of file RooAbsCollection.cxx.

◆ Streamer()

void RooAbsCollection::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in RooArgList, RooArgSet, RooCollectionProxy< RooArgList >, and RooCollectionProxy< RooArgSet >.

◆ StreamerNVirtual()

void RooAbsCollection::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 417 of file RooAbsCollection.h.

◆ structureTag()

TNamed * RooAbsCollection::structureTag ( )

inlineprotected

Definition at line 383 of file RooAbsCollection.h.

◆ takeOwnership()

void RooAbsCollection::takeOwnership ( )

inline

Definition at line 350 of file RooAbsCollection.h.

◆ typedStructureTag()

TNamed * RooAbsCollection::typedStructureTag ( )

inlineprotected

Definition at line 384 of file RooAbsCollection.h.

◆ uniqueId()

RooFit::UniqueId< RooAbsCollection > const & RooAbsCollection::uniqueId ( ) const

inline

Returns a unique ID that is different for every instantiated RooAbsCollection.

This ID can be used to check whether two collections are the same object, which is safer than memory address comparisons that might result in false positives when memory is recycled.

Definition at line 96 of file RooAbsCollection.h.

◆ useHashMapForFind()

void RooAbsCollection::useHashMapForFind ( bool flag ) const

Parameters

[in] flag Switch hash map on or off.

Definition at line 1626 of file RooAbsCollection.cxx.

Member Data Documentation

◆ _allRRV

bool RooAbsCollection::_allRRV = true

protected

All contents are RRV.

Definition at line 376 of file RooAbsCollection.h.

◆ _hashAssistedFind

std::unique_ptr<HashAssistedFind> RooAbsCollection::_hashAssistedFind

mutableprivate

!

Definition at line 410 of file RooAbsCollection.h.

◆ _list

Storage_t RooAbsCollection::_list

protected

Actual object storage.

Definition at line 371 of file RooAbsCollection.h.

◆ _name

TString RooAbsCollection::_name

protected

Our name.

Definition at line 375 of file RooAbsCollection.h.

◆ _ownCont

bool RooAbsCollection::_ownCont = false

protected

Flag to identify a list that owns its contents.

Definition at line 374 of file RooAbsCollection.h.

◆ _sizeThresholdForMapSearch

std::size_t RooAbsCollection::_sizeThresholdForMapSearch = 100

private

!

Definition at line 411 of file RooAbsCollection.h.

◆ _structureTag

TNamed* RooAbsCollection::_structureTag {nullptr}

mutableprotected

! Structure tag

Definition at line 386 of file RooAbsCollection.h.

◆ _typedStructureTag

TNamed* RooAbsCollection::_typedStructureTag {nullptr}

mutableprotected

! Typed structure tag

Definition at line 387 of file RooAbsCollection.h.

◆ _uniqueId

const RooFit::UniqueId<RooAbsCollection> RooAbsCollection::_uniqueId

private

Definition at line 415 of file RooAbsCollection.h.

Libraries for RooAbsCollection:

[legend]

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

roofit/roofitcore/inc/RooAbsCollection.h
roofit/roofitcore/src/RooAbsCollection.cxx
/home/sftnight/build/workspace/root-makedoc-v628/rootspi/rdoc/v628_TMP/pyzdoc/_roofit.pyzdoc

PyROOT

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ const_iterator

◆ HashAssistedFind

◆ LegacyIterator_t

◆ Storage_t

Constructor & Destructor Documentation

◆ RooAbsCollection() [1/4]

◆ RooAbsCollection() [2/4]

◆ ~RooAbsCollection()

◆ RooAbsCollection() [3/4]

◆ RooAbsCollection() [4/4]

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ addClone() [1/2]

◆ addClone() [2/2]

◆ addOwned() [1/4]

◆ addOwned() [2/4]

◆ addOwned() [3/4]

◆ addOwned() [4/4]

◆ addServerClonesToList()

◆ allInRange()

◆ assert_is_no_temporary()

◆ assign()

◆ assignFast()

◆ assignValueOnly()

◆ begin()

◆ canBeAdded()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ clear()

◆ clearStructureTags()

◆ clone()

◆ Clone()

◆ contains()

◆ containsInstance()

◆ contentsString()

◆ create()

◆ createIterator()

◆ DeclFileName()

◆ defaultPrintContents()

◆ deleteList()

◆ dump()

◆ empty()

◆ end()

◆ equals()

◆ find() [1/2]

◆ find() [2/2]

◆ FindObject() [1/2]

◆ FindObject() [2/2]

◆ first()

◆ fwdIterator()

◆ get()

◆ getCatIndex()

◆ getCatLabel()

◆ getHashTableSize()

◆ GetName()

◆ getRealValue()

◆ getSize()

◆ getStringValue()

◆ hasSameLayout()

◆ index() [1/3]

◆ index() [2/3]

◆ index() [3/3]

◆ insert()