Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TOrdCollection.h
Go to the documentation of this file.
1 // @(#)root/cont:$Id$
2 // Author: Fons Rademakers 13/09/95
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TOrdCollection
13 #define ROOT_TOrdCollection
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TOrdCollection //
19 // //
20 // Ordered collection. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
23 
24 #include "TSeqCollection.h"
25 
26 #include <iterator>
27 
28 
29 class TOrdCollectionIter;
30 
31 
32 class TOrdCollection : public TSeqCollection {
33 
34 friend class TOrdCollectionIter;
35 
36 private:
37  TObject **fCont;
38  Int_t fCapacity;
39  Int_t fGapStart;
40  Int_t fGapSize;
41 
42  Int_t PhysIndex(Int_t idx) const;
43  Int_t LogIndex(Int_t idx) const;
44  void MoveGapTo(Int_t newGapStart);
45  Bool_t IllegalIndex(const char *method, Int_t idx) const;
46  void Init(Int_t capacity);
47  Bool_t LowWaterMark() const;
48  void SetCapacity(Int_t newCapacity);
49 
50  TOrdCollection(const TOrdCollection&); // Not implemented
51  TOrdCollection& operator=(const TOrdCollection&); // Not implemented
52 
53 public:
54  enum { kDefaultCapacity = 1, kMinExpand = 8, kShrinkFactor = 2 };
55 
56  typedef TOrdCollectionIter Iterator_t;
57 
58  TOrdCollection(Int_t capacity = kDefaultCapacity);
59  ~TOrdCollection();
60  void Clear(Option_t *option="");
61  void Delete(Option_t *option="");
62  TObject **GetObjectRef(const TObject *obj) const;
63  Int_t IndexOf(const TObject *obj) const;
64  TIterator *MakeIterator(Bool_t dir = kIterForward) const;
65 
66  void AddFirst(TObject *obj);
67  void AddLast(TObject *obj);
68  void AddAt(TObject *obj, Int_t idx);
69  void AddAfter(const TObject *after, TObject *obj);
70  void AddBefore(const TObject *before, TObject *obj);
71  void PutAt(TObject *obj, Int_t idx);
72  TObject *RemoveAt(Int_t idx);
73  TObject *Remove(TObject *obj);
74 
75  TObject *At(Int_t idx) const;
76  TObject *Before(const TObject *obj) const;
77  TObject *After(const TObject *obj) const;
78  TObject *First() const;
79  TObject *Last() const;
80 
81  void Sort();
82  Int_t BinarySearch(TObject *obj);
83 
84  ClassDef(TOrdCollection,0) //An ordered collection
85 };
86 
87 
88 //////////////////////////////////////////////////////////////////////////
89 // //
90 // TOrdCollectionIter //
91 // //
92 // Iterator of ordered collection. //
93 // //
94 //////////////////////////////////////////////////////////////////////////
95 
96 class TOrdCollectionIter : public TIterator,
97  public std::iterator<std::bidirectional_iterator_tag,
98  TObject*, std::ptrdiff_t,
99  const TObject**, const TObject*&> {
100 
101 private:
102  const TOrdCollection *fCol; //collection being iterated
103  Int_t fCurCursor; //current position in collection
104  Int_t fCursor; //next position in collection
105  Bool_t fDirection; //iteration direction
106 
107  TOrdCollectionIter() : fCol(0), fCurCursor(0), fCursor(0), fDirection(kIterForward) { }
108 
109 public:
110  TOrdCollectionIter(const TOrdCollection *col, Bool_t dir = kIterForward);
111  TOrdCollectionIter(const TOrdCollectionIter &iter);
112  ~TOrdCollectionIter() { }
113  TIterator &operator=(const TIterator &rhs);
114  TOrdCollectionIter &operator=(const TOrdCollectionIter &rhs);
115 
116  const TCollection *GetCollection() const { return fCol; }
117  TObject *Next();
118  void Reset();
119  Bool_t operator!=(const TIterator &aIter) const;
120  Bool_t operator!=(const TOrdCollectionIter &aIter) const;
121  TObject *operator*() const;
122 
123  ClassDef(TOrdCollectionIter,0) //Ordered collection iterator
124 };
125 
126 
127 //---- inlines -----------------------------------------------------------------
128 
129 inline Bool_t TOrdCollection::LowWaterMark() const
130 {
131  return (fSize < (fCapacity / 4) && fSize > TCollection::kInitCapacity);
132 }
133 
134 inline Int_t TOrdCollection::PhysIndex(Int_t idx) const
135  { return (idx < fGapStart) ? idx : idx + fGapSize; }
136 
137 inline Int_t TOrdCollection::LogIndex(Int_t idx) const
138  { return (idx < fGapStart) ? idx : idx - fGapSize; }
139 
140 #endif