A sorted doubly linked list.

All sortable classes inheriting from TObject can be inserted in a TSortedList.

Definition at line 28 of file TSortedList.h.

Public Member Functions
	TSortedList (Bool_t order=kSortAscending)

void	Add (TObject *obj) override
	Add object in sorted list.

void	Add (TObject obj, Option_t opt) override
	Add object in sorted list.

void	AddAfter (const TObject , TObject obj) override
	Insert object after object after in the list.

void	AddAfter (TObjLink , TObject obj) override
	Insert object after the specified ObjLink object.

void	AddAt (TObject *obj, Int_t) override
	Insert object at position idx in the list.

void	AddBefore (const TObject , TObject obj) override
	Insert object before object before in the list.

void	AddBefore (TObjLink , TObject obj) override
	Insert object before the specified ObjLink object.

void	AddFirst (TObject *obj) override
	Add object at the beginning of the list.

void	AddFirst (TObject obj, Option_t opt) override
	Add object at the beginning of the list and also store option.

void	AddLast (TObject *obj) override
	Add object at the end of the list.

void	AddLast (TObject obj, Option_t opt) override
	Add object at the end of the list and also store option.

TClass *	IsA () const override

Bool_t	IsSorted () const override

void	Sort (Bool_t=kSortAscending) override
	Sort linked list.

void	Streamer (TBuffer &) override
	Stream all objects in the collection to or from the I/O buffer.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TList
	TList ()

	TList (TObject *)

virtual	~TList ()
	Delete the list.

TObject *	After (const TObject *obj) const override
	Returns the object after object obj.

TObject *	At (Int_t idx) const override
	Returns the object at position idx. Returns 0 if idx is out of range.

TObject *	Before (const TObject *obj) const override
	Returns the object before object obj.

void	Clear (Option_t *option="") override
	Remove all objects from the list.

void	Delete (Option_t *option="") override
	Remove all objects from the list AND delete all heap based objects.

TObject *	FindObject (const char *name) const override
	Find an object in this list using its name.

TObject *	FindObject (const TObject *obj) const override
	Find an object in this list using the object's IsEqual() member function.

TObject *	First () const override
	Return the first object in the list. Returns 0 when list is empty.

virtual TObjLink *	FirstLink () const

TObject **	GetObjectRef (const TObject *obj) const override
	Return address of pointer to obj.

Bool_t	IsAscending ()

TObject *	Last () const override
	Return the last object in the list. Returns 0 when list is empty.

virtual TObjLink *	LastLink () const

TIterator *	MakeIterator (Bool_t dir=kIterForward) const override
	Return a list iterator.

void	RecursiveRemove (TObject *obj) override
	Remove object from this collection and recursively remove the object from all other objects (and collections).

TObject *	Remove (const TObjLinkPtr_t &lnk)

TObject *	Remove (TObject *obj) override
	Remove object from the list.

virtual TObject *	Remove (TObjLink *lnk)
	Remove object link (and therefore the object it contains) from the list.

void	RemoveLast () override
	Remove the last object of the list.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TSeqCollection
virtual	~TSeqCollection ()

virtual Int_t	GetLast () const
	Returns index of last object in collection.

virtual Int_t	IndexOf (const TObject *obj) const
	Return index of object in collection.

Int_t	LastIndex () const

Long64_t	Merge (TCollection *list)
	Merge this collection with all collections coming in the input list.

virtual void	RemoveAfter (TObject *after)

virtual TObject *	RemoveAt (Int_t idx)

virtual void	RemoveBefore (TObject *before)

virtual void	RemoveFirst ()

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	UnSort ()

Public Member Functions inherited from TCollection
virtual	~TCollection ()
	TNamed destructor.

virtual void	AddAll (const TCollection *col)
	Add all objects from collection col to this collection.

void	AddVector (TObject *obj1,...)
	Add all arguments to the collection.

Bool_t	AssertClass (TClass *cl) const
	Make sure all objects in this collection inherit from class cl.

TIter	begin () const

void	Browse (TBrowser *b) override
	Browse this collection (called by TBrowser).

Int_t	Capacity () const

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

Int_t	Compare (const TObject *obj) const override
	Compare two TCollection objects.

Bool_t	Contains (const char *name) const

Bool_t	Contains (const TObject *obj) const

void	Draw (Option_t *option="") override
	Draw all objects in this collection.

void	Dump () const override
	Dump all objects in this collection.

TIter	end () const

virtual Int_t	GetEntries () const

const char *	GetName () const override
	Return name of this collection.

virtual Int_t	GetSize () const
	Return the capacity of the collection, i.e.

virtual Int_t	GrowBy (Int_t delta) const
	Increase the collection's capacity by delta slots.

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

Bool_t	IsArgNull (const char where, const TObject obj) const
	Returns true if object is a null pointer.

virtual Bool_t	IsEmpty () const

Bool_t	IsFolder () const override
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Bool_t	IsOwner () const

Bool_t	IsSortable () const override

R__ALWAYS_INLINE Bool_t	IsUsingRWLock () const

void	ls (Option_t *option="") const override
	List (ls) all objects in this collection.

virtual TIterator *	MakeReverseIterator () const

Bool_t	Notify () override
	'Notify' all objects in this collection.

TObject *	operator() (const char *name) const
	Find an object in this collection by name.

void	Paint (Option_t *option="") override
	Paint all objects in this collection.

virtual void	Print (Option_t option, const char wildcard, Int_t recurse=1) const
	Print the collection header and its elements that match the wildcard.

virtual void	Print (Option_t *option, Int_t recurse) const
	Print the collection header and its elements.

virtual void	Print (Option_t *option, TPRegexp &regexp, Int_t recurse=1) const
	Print the collection header and its elements that match the regexp.

void	Print (Option_t *option="") const override
	Default print for collections, calls Print(option, 1).

void	RemoveAll ()

virtual void	RemoveAll (TCollection *col)
	Remove all objects in collection col from this collection.

void	SetCurrentCollection ()
	Set this collection to be the globally accessible collection.

void	SetName (const char *name)

virtual void	SetOwner (Bool_t enable=kTRUE)
	Set whether this collection is the owner (enable==true) of its content.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual bool	UseRWLock (Bool_t enable=true)
	Set this collection to use a RW lock upon access, making it thread safe.

Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const override
	Write all objects in this collection.

Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) override
	Write all objects in this collection.

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.

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	Copy (TObject &object) const
	Copy this to obj.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

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	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.

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

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

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, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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	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.

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Int_t	ObjCompare (TObject a, TObject b)
	Compare to objects in the collection. Use member Compare() of object a.

static void	QSort (TObject **a, Int_t first, Int_t last)
	Sort array of TObject pointers using a quicksort algorithm.

static void	QSort (TObject a, Int_t nBs, TObject *b, Int_t first, Int_t last)
	Sort array a of TObject pointers using a quicksort algorithm.

static void	QSort (TObject a, TObject b, Int_t first, Int_t last)

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static void	EmptyGarbageCollection ()
	Do the garbage collection.

static void	GarbageCollect (TObject *obj)
	Add to the list of things to be cleaned up.

static TCollection *	GetCurrentCollection ()
	Return the globally accessible collection.

static void	StartGarbageCollection ()
	Set up for garbage collection.

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.

Additional Inherited Members
Public Types inherited from TList
typedef TListIter	Iterator_t

Public Types inherited from TCollection
enum	{ kInitCapacity = 16 , kInitHashTableCapacity = 17 }

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

Protected Types inherited from TList
using	TObjLinkPtr_t = std::shared_ptr< TObjLink >

using	TObjLinkWeakPtr_t = std::weak_ptr< TObjLink >

Protected Types inherited from TCollection
enum	EStatusBits { kIsOwner = (1ULL << ( 14 )) , kUseRWLock = (1ULL << ( 16 )) }

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

Protected Member Functions inherited from TList
TObjLinkPtr_t *	DoSort (TObjLinkPtr_t *head, Int_t n)
	Sort linked list.

TObjLink *	FindLink (const TObject *obj, Int_t &idx) const
	Returns the TObjLink object that contains object obj.

void	InsertAfter (const TObjLinkPtr_t &newlink, const TObjLinkPtr_t &prev)
	Insert a new link in the chain.

TObjLink *	LinkAt (Int_t idx) const
	sorting order (when calling Sort() or for TSortedList)

Bool_t	LnkCompare (const TObjLinkPtr_t &l1, const TObjLinkPtr_t &l2)
	Compares the objects stored in the TObjLink objects.

TObjLinkPtr_t	NewLink (TObject *obj, const TObjLinkPtr_t &prev=nullptr)
	Return a new TObjLink.

TObjLinkPtr_t	NewLink (TObject obj, TObjLink prev)

TObjLinkPtr_t	NewOptLink (TObject obj, Option_t opt, const TObjLinkPtr_t &prev=nullptr)
	Return a new TObjOptLink (a TObjLink that also stores the option).

TObjLinkPtr_t	NewOptLink (TObject obj, Option_t opt, TObjLink *prev)

Protected Member Functions inherited from TSeqCollection
	TSeqCollection ()

virtual void	Changed ()

Protected Member Functions inherited from TCollection
	TCollection ()

virtual const char *	GetCollectionEntryName (TObject *entry) const
	For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on.

virtual void	PrintCollectionEntry (TObject entry, Option_t option, Int_t recurse) const
	Print the collection entry.

virtual void	PrintCollectionHeader (Option_t *option) const
	Print the collection header.

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 TList
Bool_t	fAscending
	cache to speedup sequential calling of Before() and After() functions

TObjLinkWeakPtr_t	fCache
	pointer to last entry in linked list

TObjLinkPtr_t	fFirst

TObjLinkPtr_t	fLast
	pointer to first entry in linked list

Protected Attributes inherited from TSeqCollection
Bool_t	fSorted

Protected Attributes inherited from TCollection
TString	fName

Int_t	fSize

#include <TSortedList.h>

Inheritance diagram for TSortedList:

[legend]

Constructor & Destructor Documentation

◆ TSortedList()

TSortedList::TSortedList ( Bool_t order = kSortAscending )

inline

Definition at line 31 of file TSortedList.h.

Member Function Documentation

◆ Add() [1/2]

void TSortedList::Add ( TObject * obj )

overridevirtual

Add object in sorted list.

Uses object Compare() member to find right position.

Reimplemented from TList.

Definition at line 27 of file TSortedList.cxx.

◆ Add() [2/2]

void TSortedList::Add	(	TObject *	obj,
		Option_t *	opt
	)

overridevirtual

Add object in sorted list.

Uses object Compare() member to find right position and also store option. See TList::Add for explanation of usage of option.

Reimplemented from TList.

Definition at line 65 of file TSortedList.cxx.

◆ AddAfter() [1/2]

void TSortedList::AddAfter	(	const TObject *	after,
		TObject *	obj
	)

inlineoverridevirtual

Insert object after object after in the list.

Reimplemented from TList.

Definition at line 44 of file TSortedList.h.

◆ AddAfter() [2/2]

void TSortedList::AddAfter	(	TObjLink *	after,
		TObject *	obj
	)

inlineoverridevirtual

Insert object after the specified ObjLink object.

If after = 0 then add to the tail of the list. An ObjLink can be obtained by looping over a list using the above describe iterator method 3.

Reimplemented from TList.

Definition at line 45 of file TSortedList.h.

◆ AddAt()

void TSortedList::AddAt	(	TObject *	obj,
		Int_t	idx
	)

inlineoverridevirtual

Insert object at position idx in the list.

Reimplemented from TList.

Definition at line 43 of file TSortedList.h.

◆ AddBefore() [1/2]

void TSortedList::AddBefore	(	const TObject *	before,
		TObject *	obj
	)

inlineoverridevirtual

Insert object before object before in the list.

Reimplemented from TList.

Definition at line 46 of file TSortedList.h.

◆ AddBefore() [2/2]

void TSortedList::AddBefore	(	TObjLink *	before,
		TObject *	obj
	)

inlineoverridevirtual

Insert object before the specified ObjLink object.

If before = 0 then add to the head of the list. An ObjLink can be obtained by looping over a list using the above describe iterator method 3.

Reimplemented from TList.

Definition at line 47 of file TSortedList.h.

◆ AddFirst() [1/2]

void TSortedList::AddFirst ( TObject * obj )

inlineoverridevirtual

Add object at the beginning of the list.

Reimplemented from TList.

Definition at line 39 of file TSortedList.h.

◆ AddFirst() [2/2]

void TSortedList::AddFirst	(	TObject *	obj,
		Option_t *	opt
	)

inlineoverridevirtual

Add object at the beginning of the list and also store option.

Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.

Reimplemented from TList.

Definition at line 40 of file TSortedList.h.

◆ AddLast() [1/2]

void TSortedList::AddLast ( TObject * obj )

inlineoverridevirtual

Add object at the end of the list.

Reimplemented from TList.

Definition at line 41 of file TSortedList.h.

◆ AddLast() [2/2]

void TSortedList::AddLast	(	TObject *	obj,
		Option_t *	opt
	)

inlineoverridevirtual

Add object at the end of the list and also store option.

Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.

Reimplemented from TList.

Definition at line 42 of file TSortedList.h.

◆ Class()

static TClass * TSortedList::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TSortedList::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TSortedList::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 50 of file TSortedList.h.

◆ DeclFileName()

static const char * TSortedList::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 50 of file TSortedList.h.

◆ IsA()

TClass * TSortedList::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TList.

Definition at line 50 of file TSortedList.h.

◆ IsSorted()

Bool_t TSortedList::IsSorted ( ) const

inlineoverridevirtual

Reimplemented from TSeqCollection.

Definition at line 36 of file TSortedList.h.

◆ Sort()

void TSortedList::Sort ( Bool_t order = kSortAscending )

inlineoverridevirtual

Sort linked list.

Real sorting is done in private function DoSort(). The list can only be sorted when is contains objects of a sortable class.

Reimplemented from TList.

Definition at line 48 of file TSortedList.h.

◆ Streamer()

void TSortedList::Streamer ( TBuffer & b )

overridevirtual

Stream all objects in the collection to or from the I/O buffer.

Reimplemented from TList.

◆ StreamerNVirtual()

void TSortedList::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 50 of file TSortedList.h.

core/cont/inc/TSortedList.h

core/cont/src/TSortedList.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TSortedList()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddAfter() [1/2]

◆ AddAfter() [2/2]

◆ AddAt()

◆ AddBefore() [1/2]

◆ AddBefore() [2/2]

◆ AddFirst() [1/2]

◆ AddFirst() [2/2]

◆ AddLast() [1/2]

◆ AddLast() [2/2]

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ IsA()

◆ IsSorted()

◆ Sort()

◆ Streamer()

◆ StreamerNVirtual()