0029492: Coding Rules. NCollection_IndexedDataMap - add missing documentation to...
[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 public:
51   //! STL-compliant typedef for key type
52   typedef TheKeyType key_type;
53   //! STL-compliant typedef for value type
54   typedef TheItemType value_type;
55
56 public:
57   // **************** Adaptation of the TListNode to the DATAmap
58   class DataMapNode : public NCollection_TListNode<TheItemType>
59   {
60   public:
61     //! Constructor with 'Next'
62     DataMapNode (const TheKeyType&     theKey, 
63                  const TheItemType&    theItem, 
64                  NCollection_ListNode* theNext) :
65       NCollection_TListNode<TheItemType> (theItem, theNext),
66       myKey(theKey)
67     {}
68
69     //! Key
70     const TheKeyType& Key (void) const
71     { return myKey; }
72     
73     //! Static deleter to be passed to BaseMap
74     static void delNode (NCollection_ListNode * theNode, 
75                          Handle(NCollection_BaseAllocator)& theAl)
76     {
77       ((DataMapNode *) theNode)->~DataMapNode();
78       theAl->Free(theNode);
79     }
80
81   private:
82     TheKeyType    myKey;
83   };
84
85  public:
86   // **************** Implementation of the Iterator interface.
87   class Iterator : public NCollection_BaseMap::Iterator
88   {
89   public:
90     //! Empty constructor
91     Iterator (void) :
92       NCollection_BaseMap::Iterator() {}
93     //! Constructor
94     Iterator (const NCollection_DataMap& theMap) :
95       NCollection_BaseMap::Iterator(theMap) {}
96     //! Query if the end of collection is reached by iterator
97     Standard_Boolean More(void) const
98     { return PMore(); }
99     //! Make a step along the collection
100     void Next(void)
101     { PNext(); }
102     //! Value inquiry
103     const TheItemType& Value(void) const
104     {  
105       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::Value");  
106       return ((DataMapNode *) myNode)->Value();
107     }
108     //! Value change access
109     TheItemType& ChangeValue(void) const
110     {  
111       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::ChangeValue");  
112       return ((DataMapNode *) myNode)->ChangeValue();
113     }
114     //! Key
115     const TheKeyType& Key (void) const
116     { 
117       Standard_NoSuchObject_Raise_if(!More(), "NCollection_DataMap::Iterator::Key");  
118       return ((DataMapNode *) myNode)->Key();
119     }
120   };
121   
122   //! Shorthand for a regular iterator type.
123   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, false> iterator;
124
125   //! Shorthand for a constant iterator type.
126   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, true> const_iterator;
127
128   //! Returns an iterator pointing to the first element in the map.
129   iterator begin() const { return Iterator (*this); }
130
131   //! Returns an iterator referring to the past-the-end element in the map.
132   iterator end() const { return Iterator(); }
133
134   //! Returns a const iterator pointing to the first element in the map.
135   const_iterator cbegin() const { return Iterator (*this); }
136
137   //! Returns a const iterator referring to the past-the-end element in the map.
138   const_iterator cend() const { return Iterator(); }
139
140  public:
141   // ---------- PUBLIC METHODS ------------
142
143   //! Empty Constructor.
144   NCollection_DataMap() : NCollection_BaseMap (1, Standard_True, Handle(NCollection_BaseAllocator)()) {}
145
146   //! Constructor
147   explicit NCollection_DataMap (const Standard_Integer theNbBuckets,
148                                 const Handle(NCollection_BaseAllocator)& theAllocator = 0L)
149   : NCollection_BaseMap (theNbBuckets, Standard_True, theAllocator) {}
150
151   //! Copy constructor
152   NCollection_DataMap (const NCollection_DataMap& theOther)
153     : NCollection_BaseMap (theOther.NbBuckets(), Standard_True, theOther.myAllocator) 
154   { *this = theOther; }
155
156   //! Exchange the content of two maps without re-allocations.
157   //! Notice that allocators will be swapped as well!
158   void Exchange (NCollection_DataMap& theOther)
159   {
160     this->exchangeMapsData (theOther);
161   }
162
163   //! Assignment.
164   //! This method does not change the internal allocator.
165   NCollection_DataMap& Assign (const NCollection_DataMap& theOther)
166   { 
167     if (this == &theOther)
168       return *this;
169
170     Clear();
171     ReSize (theOther.Extent()-1);
172     Iterator anIter(theOther);
173     for (; anIter.More(); anIter.Next())
174       Bind (anIter.Key(), anIter.Value());
175     return *this;
176   }
177
178   //! Assignment operator
179   NCollection_DataMap& operator= (const NCollection_DataMap& theOther)
180   { 
181     return Assign (theOther);
182   }
183
184   //! ReSize
185   void ReSize (const Standard_Integer N)
186   {
187     NCollection_ListNode** newdata = NULL;
188     NCollection_ListNode** dummy   = NULL;
189     Standard_Integer newBuck;
190     if (BeginResize (N, newBuck, newdata, dummy))
191     {
192       if (myData1) 
193       {
194         DataMapNode** olddata = (DataMapNode**) myData1;
195         DataMapNode *p, *q;
196         Standard_Integer i,k;
197         for (i = 0; i <= NbBuckets(); i++) 
198         {
199           if (olddata[i]) 
200           {
201             p = olddata[i];
202             while (p) 
203             {
204               k = Hasher::HashCode(p->Key(),newBuck);
205               q = (DataMapNode*) p->Next();
206               p->Next() = newdata[k];
207               newdata[k] = p;
208               p = q;
209             }
210           }
211         }
212       }
213       EndResize (N, newBuck, newdata, dummy);
214     }
215   }
216
217   //! Bind binds Item to Key in map.
218   //! @param theKey  key to add/update
219   //! @param theItem new item; overrides value previously bound to the key, if any
220   //! @return Standard_True if Key was not bound already
221   Standard_Boolean Bind (const TheKeyType& theKey, const TheItemType& theItem)
222   {
223     if (Resizable()) 
224       ReSize(Extent());
225     DataMapNode** data = (DataMapNode**)myData1;
226     Standard_Integer k = Hasher::HashCode (theKey, NbBuckets());
227     DataMapNode* p = data[k];
228     while (p) 
229     {
230       if (Hasher::IsEqual(p->Key(), theKey))
231       {
232         p->ChangeValue() = theItem;
233         return Standard_False;
234       }
235       p = (DataMapNode *) p->Next();
236     }
237     data[k] = new (this->myAllocator) DataMapNode (theKey, theItem, data[k]);
238     Increment();
239     return Standard_True;
240   }
241
242   //! Bound binds Item to Key in map. Returns modifiable Item 
243   TheItemType* Bound (const TheKeyType& theKey, const TheItemType& theItem)
244   {
245     if (Resizable()) 
246       ReSize(Extent());
247     DataMapNode** data = (DataMapNode**)myData1;
248     Standard_Integer k = Hasher::HashCode (theKey, NbBuckets());
249     DataMapNode* p = data[k];
250     while (p)
251     {
252       if (Hasher::IsEqual(p->Key(), theKey))
253       {
254         p->ChangeValue() = theItem;
255         return &p->ChangeValue();
256       }
257       p = (DataMapNode*)p->Next();
258     }
259     data[k] = new (this->myAllocator) DataMapNode (theKey, theItem, data[k]);
260     Increment();
261     return &data[k]->ChangeValue();
262   }
263
264   //! IsBound
265   Standard_Boolean IsBound(const TheKeyType& theKey) const
266   {
267     DataMapNode* p;
268     return lookup(theKey, p);
269   }
270
271   //! UnBind removes Item Key pair from map
272   Standard_Boolean UnBind(const TheKeyType& theKey)
273   {
274     if (IsEmpty()) 
275       return Standard_False;
276     DataMapNode** data = (DataMapNode**) myData1;
277     Standard_Integer k = Hasher::HashCode(theKey,NbBuckets());
278     DataMapNode* p = data[k];
279     DataMapNode* q = NULL;
280     while (p) 
281     {
282       if (Hasher::IsEqual(p->Key(), theKey))
283       {
284         Decrement();
285         if (q) 
286           q->Next() = p->Next();
287         else
288           data[k] = (DataMapNode*) p->Next();
289         p->~DataMapNode();
290         this->myAllocator->Free(p);
291         return Standard_True;
292       }
293       q = p;
294       p = (DataMapNode*) p->Next();
295     }
296     return Standard_False;
297   }
298
299   //! Seek returns pointer to Item by Key. Returns
300   //! NULL is Key was not bound.
301   const TheItemType* Seek(const TheKeyType& theKey) const
302   {
303     DataMapNode* p = 0;
304     if (!lookup(theKey, p))
305       return 0L;
306     return &p->Value();
307   }
308
309   //! Find returns the Item for Key. Raises if Key was not bound
310   const TheItemType& Find(const TheKeyType& theKey) const
311   {
312     DataMapNode* p = 0;
313     if (!lookup(theKey, p))
314       throw Standard_NoSuchObject("NCollection_DataMap::Find");
315     return p->Value();
316   }
317
318   //! Find Item for key with copying.
319   //! @return true if key was found
320   Standard_Boolean Find (const TheKeyType& theKey,
321                          TheItemType&      theValue) const
322   {
323     DataMapNode* p = 0;
324     if (!lookup(theKey, p))
325       return Standard_False;
326
327     theValue = p->Value();
328     return Standard_True;
329   }
330
331   //! operator ()
332   const TheItemType& operator() (const TheKeyType& theKey) const
333   { return Find(theKey); }
334
335   //! ChangeSeek returns modifiable pointer to Item by Key. Returns
336   //! NULL is Key was not bound.
337   TheItemType* ChangeSeek(const TheKeyType& theKey)
338   {
339     DataMapNode* p = 0;
340     if (!lookup(theKey, p))
341       return 0L;
342     return &p->ChangeValue();
343   }
344
345   //! ChangeFind returns mofifiable Item by Key. Raises if Key was not bound
346   TheItemType& ChangeFind (const TheKeyType& theKey)
347   {
348     DataMapNode* p = 0;
349     if (!lookup(theKey, p))
350       throw Standard_NoSuchObject("NCollection_DataMap::Find");
351     return p->ChangeValue();
352   }
353
354   //! operator ()
355   TheItemType& operator() (const TheKeyType& theKey)
356   { return ChangeFind(theKey); }
357
358   //! Clear data. If doReleaseMemory is false then the table of
359   //! buckets is not released and will be reused.
360   void Clear(const Standard_Boolean doReleaseMemory = Standard_True)
361   { Destroy (DataMapNode::delNode, doReleaseMemory); }
362
363   //! Clear data and reset allocator
364   void Clear (const Handle(NCollection_BaseAllocator)& theAllocator)
365   { 
366     Clear();
367     this->myAllocator = ( ! theAllocator.IsNull() ? theAllocator :
368                     NCollection_BaseAllocator::CommonBaseAllocator() );
369   }
370
371   //! Destructor
372   virtual ~NCollection_DataMap (void)
373   { Clear(); }
374
375   //! Size
376   Standard_Integer Size(void) const
377   { return Extent(); }
378
379   
380  protected:
381   // ---------- PROTECTED METHODS ----------
382   //! Lookup for particular key in map. Returns true if key is found and
383   //! thepNode points to binded node. Returns false if key is not found,
384   //! thehNode value is this case is not usable.
385   Standard_Boolean lookup(const TheKeyType& theKey,DataMapNode*& thepNode) const
386   {
387     if (IsEmpty())
388       return Standard_False; // Not found
389     for (thepNode = (DataMapNode*)myData1[Hasher::HashCode(theKey, NbBuckets())];
390          thepNode; thepNode = (DataMapNode*)thepNode->Next())
391     {
392       if (Hasher::IsEqual(thepNode->Key(), theKey)) 
393         return Standard_True;
394     }
395     return Standard_False; // Not found
396   }
397
398 };
399
400 #endif
401