a8cb2d63e010c5959df190d016f00e9bad1b092e
[occt.git] / src / NCollection / NCollection_DataMap.hxx
1 // Created on: 2002-04-24
2 // Created by: Alexander KARTOMIN (akm)
3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef NCollection_DataMap_HeaderFile
17 #define NCollection_DataMap_HeaderFile
18
19 #include <NCollection_BaseMap.hxx>
20 #include <NCollection_TListNode.hxx>
21 #include <NCollection_StlIterator.hxx>
22 #include <NCollection_DefaultHasher.hxx>
23
24 #include <Standard_TypeMismatch.hxx>
25 #include <Standard_NoSuchObject.hxx>
26
27 /**
28 * Purpose:     The DataMap is a Map to store keys with associated
29 *              Items. See Map  from NCollection for  a discussion
30 *              about the number of buckets.
31 *
32 *              The DataMap can be seen as an extended array where
33 *              the Keys  are the   indices.  For this reason  the
34 *              operator () is defined on DataMap to fetch an Item
35 *              from a Key. So the following syntax can be used :
36 *
37 *              anItem = aMap(aKey);
38 *              aMap(aKey) = anItem;
39 *
40 *              This analogy has its  limit.   aMap(aKey) = anItem
41 *              can  be done only  if aKey was previously bound to
42 *              an item in the map.
43 */              
44
45 template < class TheKeyType, 
46            class TheItemType, 
47            class Hasher = NCollection_DefaultHasher<TheKeyType> >
48 class NCollection_DataMap : public NCollection_BaseMap
49 {
50   // **************** Adaptation of the TListNode to the DATAmap
51  public:
52   class DataMapNode : public NCollection_TListNode<TheItemType>
53   {
54   public:
55     //! Constructor with 'Next'
56     DataMapNode (const TheKeyType&     theKey, 
57                  const TheItemType&    theItem, 
58                  NCollection_ListNode* theNext) :
59       NCollection_TListNode<TheItemType> (theItem, theNext),
60       myKey(theKey)
61     {}
62
63     //! Key
64     const TheKeyType& Key (void) const
65     { return myKey; }
66     
67     //! Static deleter to be passed to BaseMap
68     static void delNode (NCollection_ListNode * theNode, 
69                          Handle(NCollection_BaseAllocator)& theAl)
70     {
71       ((DataMapNode *) theNode)->~DataMapNode();
72       theAl->Free(theNode);
73     }
74
75   private:
76     TheKeyType    myKey;
77   };
78
79  public:
80   // **************** Implementation of the Iterator interface.
81   class Iterator : public NCollection_BaseMap::Iterator
82   {
83   public:
84     //! Empty constructor
85     Iterator (void) :
86       NCollection_BaseMap::Iterator() {}
87     //! Constructor
88     Iterator (const NCollection_DataMap& theMap) :
89       NCollection_BaseMap::Iterator(theMap) {}
90     //! Query if the end of collection is reached by iterator
91     Standard_Boolean More(void) const
92     { return PMore(); }
93     //! Make a step along the collection
94     void Next(void)
95     { PNext(); }
96     //! Value inquiry
97     const TheItemType& Value(void) const
98     {  
99       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::Value");  
100       return ((DataMapNode *) myNode)->Value();
101     }
102     //! Value change access
103     TheItemType& ChangeValue(void) const
104     {  
105       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::ChangeValue");  
106       return ((DataMapNode *) myNode)->ChangeValue();
107     }
108     //! Key
109     const TheKeyType& Key (void) const
110     { 
111       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::Key");  
112       return ((DataMapNode *) myNode)->Key();
113     }
114   };
115   
116   //! Shorthand for a regular iterator type.
117   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, false> iterator;
118
119   //! Shorthand for a constant iterator type.
120   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, true> const_iterator;
121
122   //! Returns an iterator pointing to the first element in the map.
123   iterator begin() const { return Iterator (*this); }
124
125   //! Returns an iterator referring to the past-the-end element in the map.
126   iterator end() const { return Iterator(); }
127
128   //! Returns a const iterator pointing to the first element in the map.
129   const_iterator cbegin() const { return Iterator (*this); }
130
131   //! Returns a const iterator referring to the past-the-end element in the map.
132   const_iterator cend() const { return Iterator(); }
133
134  public:
135   // ---------- PUBLIC METHODS ------------
136
137   //! Constructor
138   NCollection_DataMap (const Standard_Integer NbBuckets=1,
139                      const Handle(NCollection_BaseAllocator)& theAllocator = 0L)
140     : NCollection_BaseMap (NbBuckets, Standard_True, theAllocator) {}
141
142   //! Copy constructor
143   NCollection_DataMap (const NCollection_DataMap& theOther)
144     : NCollection_BaseMap (theOther.NbBuckets(), Standard_True, theOther.myAllocator) 
145   { *this = theOther; }
146
147   //! Exchange the content of two maps without re-allocations.
148   //! Notice that allocators will be swapped as well!
149   void Exchange (NCollection_DataMap& theOther)
150   {
151     this->exchangeMapsData (theOther);
152   }
153
154   //! Assignment
155   NCollection_DataMap& Assign (const NCollection_DataMap& theOther)
156   { 
157     if (this == &theOther)
158       return *this;
159
160     Clear(theOther.myAllocator);
161     ReSize (theOther.Extent()-1);
162     Iterator anIter(theOther);
163     for (; anIter.More(); anIter.Next())
164       Bind (anIter.Key(), anIter.Value());
165     return *this;
166   }
167
168   //! Assignment operator
169   NCollection_DataMap& operator= (const NCollection_DataMap& theOther)
170   { 
171     return Assign (theOther);
172   }
173
174   //! ReSize
175   void ReSize (const Standard_Integer N)
176   {
177     NCollection_ListNode** newdata = NULL;
178     NCollection_ListNode** dummy   = NULL;
179     Standard_Integer newBuck;
180     if (BeginResize (N, newBuck, newdata, dummy))
181     {
182       if (myData1) 
183       {
184         DataMapNode** olddata = (DataMapNode**) myData1;
185         DataMapNode *p, *q;
186         Standard_Integer i,k;
187         for (i = 0; i <= NbBuckets(); i++) 
188         {
189           if (olddata[i]) 
190           {
191             p = olddata[i];
192             while (p) 
193             {
194               k = Hasher::HashCode(p->Key(),newBuck);
195               q = (DataMapNode*) p->Next();
196               p->Next() = newdata[k];
197               newdata[k] = p;
198               p = q;
199             }
200           }
201         }
202       }
203       EndResize (N, newBuck, newdata, dummy);
204     }
205   }
206
207   //! Bind binds Item to Key in map. Returns Standard_True if Key was not
208   //! exist in the map. If the Key was already bound, the Item will be rebinded
209   //! and Standard_False will be returned.
210   Standard_Boolean Bind (const TheKeyType& theKey, const TheItemType& theItem)
211   {
212     if (Resizable()) 
213       ReSize(Extent());
214     DataMapNode** data = (DataMapNode**)myData1;
215     Standard_Integer k = Hasher::HashCode (theKey, NbBuckets());
216     DataMapNode* p = data[k];
217     while (p) 
218     {
219       if (Hasher::IsEqual(p->Key(), theKey))
220       {
221         p->ChangeValue() = theItem;
222         return Standard_False;
223       }
224       p = (DataMapNode *) p->Next();
225     }
226     data[k] = new (this->myAllocator) DataMapNode (theKey, theItem, data[k]);
227     Increment();
228     return Standard_True;
229   }
230
231   //! Bound binds Item to Key in map. Returns modifiable Item 
232   TheItemType* Bound (const TheKeyType& theKey, const TheItemType& theItem)
233   {
234     if (Resizable()) 
235       ReSize(Extent());
236     DataMapNode** data = (DataMapNode**)myData1;
237     Standard_Integer k = Hasher::HashCode (theKey, NbBuckets());
238     DataMapNode* p = data[k];
239     while (p)
240     {
241       if (Hasher::IsEqual(p->Key(), theKey))
242       {
243         p->ChangeValue() = theItem;
244         return &p->ChangeValue();
245       }
246       p = (DataMapNode*)p->Next();
247     }
248     data[k] = new (this->myAllocator) DataMapNode (theKey, theItem, data[k]);
249     Increment();
250     return &data[k]->ChangeValue();
251   }
252
253   //! IsBound
254   Standard_Boolean IsBound(const TheKeyType& K) const
255   {
256     DataMapNode* p;
257     return lookup(K, p);
258   }
259
260   //! UnBind removes Item Key pair from map
261   Standard_Boolean UnBind(const TheKeyType& K)
262   {
263     if (IsEmpty()) 
264       return Standard_False;
265     DataMapNode** data = (DataMapNode**) myData1;
266     Standard_Integer k = Hasher::HashCode(K,NbBuckets());
267     DataMapNode* p = data[k];
268     DataMapNode* q = NULL;
269     while (p) 
270     {
271       if (Hasher::IsEqual(p->Key(),K)) 
272       {
273         Decrement();
274         if (q) 
275           q->Next() = p->Next();
276         else
277           data[k] = (DataMapNode*) p->Next();
278         p->~DataMapNode();
279         this->myAllocator->Free(p);
280         return Standard_True;
281       }
282       q = p;
283       p = (DataMapNode*) p->Next();
284     }
285     return Standard_False;
286   }
287
288   //! Seek returns pointer to Item by Key. Returns
289   //! NULL is Key was not bound.
290   const TheItemType* Seek(const TheKeyType& theKey) const
291   {
292     DataMapNode* p = 0;
293     if (!lookup(theKey, p))
294       return 0L;
295     return &p->Value();
296   }
297
298   //! Find returns the Item for Key. Raises if Key was not bound
299   const TheItemType& Find(const TheKeyType& theKey) const
300   {
301     DataMapNode* p = 0;
302     if (!lookup(theKey, p))
303       Standard_NoSuchObject::Raise("NCollection_DataMap::Find");
304     return p->Value();
305   }
306
307   //! Find Item for key with copying.
308   //! @return true if key was found
309   Standard_Boolean Find (const TheKeyType& theKey,
310                          TheItemType&      theValue) const
311   {
312     DataMapNode* p = 0;
313     if (!lookup(theKey, p))
314       return Standard_False;
315
316     theValue = p->Value();
317     return Standard_True;
318   }
319
320   //! operator ()
321   const TheItemType& operator() (const TheKeyType& theKey) const
322   { return Find(theKey); }
323
324   //! ChangeSeek returns modifiable pointer to Item by Key. Returns
325   //! NULL is Key was not bound.
326   TheItemType* ChangeSeek(const TheKeyType& theKey)
327   {
328     DataMapNode* p = 0;
329     if (!lookup(theKey, p))
330       return 0L;
331     return &p->ChangeValue();
332   }
333
334   //! ChangeFind returns mofifiable Item by Key. Raises if Key was not bound
335   TheItemType& ChangeFind (const TheKeyType& theKey)
336   {
337     DataMapNode* p = 0;
338     if (!lookup(theKey, p))
339       Standard_NoSuchObject::Raise("NCollection_DataMap::Find");
340     return p->ChangeValue();
341   }
342
343   //! operator ()
344   TheItemType& operator() (const TheKeyType& theKey)
345   { return ChangeFind(theKey); }
346
347   //! Clear data. If doReleaseMemory is false then the table of
348   //! buckets is not released and will be reused.
349   void Clear(const Standard_Boolean doReleaseMemory = Standard_True)
350   { Destroy (DataMapNode::delNode, doReleaseMemory); }
351
352   //! Clear data and reset allocator
353   void Clear (const Handle(NCollection_BaseAllocator)& theAllocator)
354   { 
355     Clear();
356     this->myAllocator = ( ! theAllocator.IsNull() ? theAllocator :
357                     NCollection_BaseAllocator::CommonBaseAllocator() );
358   }
359
360   //! Destructor
361   ~NCollection_DataMap (void)
362   { Clear(); }
363
364   //! Size
365   Standard_Integer Size(void) const
366   { return Extent(); }
367
368   
369  protected:
370   // ---------- PROTECTED METHODS ----------
371   //! Lookup for particular key in map. Returns true if key is found and
372   //! thepNode points to binded node. Returns false if key is not found,
373   //! thehNode value is this case is not usable.
374   Standard_Boolean lookup(const TheKeyType& theKey,DataMapNode*& thepNode) const
375   {
376     if (IsEmpty())
377       return Standard_False; // Not found
378     for (thepNode = (DataMapNode*)myData1[Hasher::HashCode(theKey, NbBuckets())];
379          thepNode; thepNode = (DataMapNode*)thepNode->Next())
380     {
381       if (Hasher::IsEqual(thepNode->Key(), theKey)) 
382         return Standard_True;
383     }
384     return Standard_False; // Not found
385   }
386
387 };
388
389 #endif
390