Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TEntryListBlock Class Reference

Used by TEntryList to store the entry numbers.

There are 2 ways to represent entry numbers in a TEntryListBlock:

  1. as bits, where passing entry numbers are assigned 1, not passing - 0
  2. as a simple array of entry numbers
    • storing the numbers of entries that pass
    • storing the numbers of entries that don't pass

In both cases, a UShort_t* is used. The second option is better in case less than 1/16 or more than 15/16 of entries pass the selection, and the representation can be changed by calling OptimizeStorage() function. When the block is being filled, it's always stored as bits, and the OptimizeStorage() function is called by TEntryList when it starts filling the next block. If Enter() or Remove() is called after OptimizeStorage(), representation is again changed to 1).

Operations on blocks (see also function comments)

  • Merge() - adds all entries from one block to the other. If the first block uses array representation, it's changed to bits representation only if the total number of passing entries is still less than kBlockSize
  • GetEntry(n) - returns n-th non-zero entry.
  • Next() - return next non-zero entry. In case of representation 1), Next() is faster than GetEntry()

Definition at line 43 of file TEntryListBlock.h.

Public Types

enum  { kBlockSize = 4000 }
 
- 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 Member Functions

 TEntryListBlock ()
 Default c-tor.
 
 TEntryListBlock (const TEntryListBlock &eblock)
 Copy c-tor.
 
 ~TEntryListBlock ()
 Destructor.
 
Int_t Contains (Int_t entry)
 True if the block contains entry #entry.
 
Bool_t Enter (Int_t entry)
 If the block has already been optimized and the entries are stored as a list and not as bits, trying to enter a new entry will make the block switch to bits representation.
 
Int_t GetEntry (Int_t entry)
 Return entry #entry.
 
Int_t GetNPassed ()
 Returns the number of entries, passing the selection.
 
Int_t GetType ()
 
virtual TClassIsA () const
 
Int_t Merge (TEntryListBlock *block)
 Merge with the other block Returns the resulting number of entries in the block.
 
Int_t Next ()
 Return the next non-zero entry Faster than GetEntry() function.
 
TEntryListBlockoperator= (const TEntryListBlock &rhs)
 
void OptimizeStorage ()
 If there are < kBlockSize or >kBlockSize*15 entries, change to an array representation.
 
virtual void Print (const Option_t *option="") const
 Print the entries in this block.
 
void PrintWithShift (Int_t shift) const
 Print the indices of this block + shift (used from TEntryList::Print()) to print the current values.
 
Bool_t Remove (Int_t entry)
 Remove entry #entry If the block has already been optimized and the entries are stored as a list and not as bits, trying to remove a new entry will make the block switch to bits representation.
 
void ResetIndices ()
 
virtual void Streamer (TBuffer &)
 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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual 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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
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.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Member Functions

void Transform (Bool_t dir, UShort_t *indexnew)
 Transform the existing fIndices.
 
- 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

UShort_t fCurrent
 ! to fasten Contains() in list mode
 
UShort_tfIndices
 [fN]
 
Int_t fLastIndexQueried
 ! to optimize GetEntry() in a loop
 
Int_t fLastIndexReturned
 ! to optimize GetEntry() in a loop
 
Int_t fN
 size of fIndices for I/O =fNPassed for list, fBlockSize for bits
 
Int_t fNPassed
 number of entries in the entry list (if fPassing=0 - number of entries not in the entry list
 
Bool_t fPassing
 1 - stores entries that belong to the list 0 - stores entries that don't belong to the list
 
Int_t fType
 0 - bits, 1 - list
 

Additional Inherited Members

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

#include <TEntryListBlock.h>

Inheritance diagram for TEntryListBlock:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kBlockSize 

Definition at line 61 of file TEntryListBlock.h.

Constructor & Destructor Documentation

◆ TEntryListBlock() [1/2]

TEntryListBlock::TEntryListBlock ( )

Default c-tor.

Definition at line 53 of file TEntryListBlock.cxx.

◆ TEntryListBlock() [2/2]

TEntryListBlock::TEntryListBlock ( const TEntryListBlock eblock)

Copy c-tor.

Definition at line 68 of file TEntryListBlock.cxx.

◆ ~TEntryListBlock()

TEntryListBlock::~TEntryListBlock ( )

Destructor.

Definition at line 89 of file TEntryListBlock.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 80 of file TEntryListBlock.h.

◆ Contains()

Int_t TEntryListBlock::Contains ( Int_t  entry)

True if the block contains entry #entry.

Definition at line 193 of file TEntryListBlock.cxx.

◆ DeclFileName()

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

Definition at line 80 of file TEntryListBlock.h.

◆ Enter()

Bool_t TEntryListBlock::Enter ( Int_t  entry)

If the block has already been optimized and the entries are stored as a list and not as bits, trying to enter a new entry will make the block switch to bits representation.

Definition at line 127 of file TEntryListBlock.cxx.

◆ GetEntry()

Int_t TEntryListBlock::GetEntry ( Int_t  entry)

Return entry #entry.

See also Next()

Definition at line 381 of file TEntryListBlock.cxx.

◆ GetNPassed()

Int_t TEntryListBlock::GetNPassed ( )

Returns the number of entries, passing the selection.

In case, when the block stores entries that pass (fPassing=1) returns fNPassed

Definition at line 369 of file TEntryListBlock.cxx.

◆ GetType()

Int_t TEntryListBlock::GetType ( )
inline

Definition at line 75 of file TEntryListBlock.h.

◆ IsA()

virtual TClass * TEntryListBlock::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 80 of file TEntryListBlock.h.

◆ Merge()

Int_t TEntryListBlock::Merge ( TEntryListBlock block)

Merge with the other block Returns the resulting number of entries in the block.

Definition at line 242 of file TEntryListBlock.cxx.

◆ Next()

Int_t TEntryListBlock::Next ( )

Return the next non-zero entry Faster than GetEntry() function.

Definition at line 446 of file TEntryListBlock.cxx.

◆ operator=()

TEntryListBlock & TEntryListBlock::operator= ( const TEntryListBlock rhs)

Definition at line 98 of file TEntryListBlock.cxx.

◆ OptimizeStorage()

void TEntryListBlock::OptimizeStorage ( )

If there are < kBlockSize or >kBlockSize*15 entries, change to an array representation.

Definition at line 546 of file TEntryListBlock.cxx.

◆ Print()

void TEntryListBlock::Print ( const Option_t option = "") const
virtual

Print the entries in this block.

Definition at line 492 of file TEntryListBlock.cxx.

◆ PrintWithShift()

void TEntryListBlock::PrintWithShift ( Int_t  shift) const

Print the indices of this block + shift (used from TEntryList::Print()) to print the current values.

Definition at line 503 of file TEntryListBlock.cxx.

◆ Remove()

Bool_t TEntryListBlock::Remove ( Int_t  entry)

Remove entry #entry If the block has already been optimized and the entries are stored as a list and not as bits, trying to remove a new entry will make the block switch to bits representation.

Definition at line 165 of file TEntryListBlock.cxx.

◆ ResetIndices()

void TEntryListBlock::ResetIndices ( )
inline

Definition at line 74 of file TEntryListBlock.h.

◆ Streamer()

virtual void TEntryListBlock::Streamer ( TBuffer R__b)
virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TEntryListBlock::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 80 of file TEntryListBlock.h.

◆ Transform()

void TEntryListBlock::Transform ( Bool_t  dir,
UShort_t indexnew 
)
protected

Transform the existing fIndices.

  • dir=0 - transform from bits to a list
  • dir=1 - tranform from a list to bits

Definition at line 563 of file TEntryListBlock.cxx.

Member Data Documentation

◆ fCurrent

UShort_t TEntryListBlock::fCurrent
protected

! to fasten Contains() in list mode

Definition at line 53 of file TEntryListBlock.h.

◆ fIndices

UShort_t* TEntryListBlock::fIndices
protected

[fN]

Definition at line 49 of file TEntryListBlock.h.

◆ fLastIndexQueried

Int_t TEntryListBlock::fLastIndexQueried
protected

! to optimize GetEntry() in a loop

Definition at line 54 of file TEntryListBlock.h.

◆ fLastIndexReturned

Int_t TEntryListBlock::fLastIndexReturned
protected

! to optimize GetEntry() in a loop

Definition at line 55 of file TEntryListBlock.h.

◆ fN

Int_t TEntryListBlock::fN
protected

size of fIndices for I/O =fNPassed for list, fBlockSize for bits

Definition at line 48 of file TEntryListBlock.h.

◆ fNPassed

Int_t TEntryListBlock::fNPassed
protected

number of entries in the entry list (if fPassing=0 - number of entries not in the entry list

Definition at line 46 of file TEntryListBlock.h.

◆ fPassing

Bool_t TEntryListBlock::fPassing
protected

1 - stores entries that belong to the list 0 - stores entries that don't belong to the list

Definition at line 51 of file TEntryListBlock.h.

◆ fType

Int_t TEntryListBlock::fType
protected

0 - bits, 1 - list

Definition at line 50 of file TEntryListBlock.h.

Libraries for TEntryListBlock:

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