src/foam/containers/HashTables/Map/Map.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::Map
  26
  27 Description
  28     A HashTable to objects of type \<T\> with a label key.
  29
  30 See Also
  31     PtrMap
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef Map_H
  36 #define Map_H
  37
  38 #include "HashTable.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class Map Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class T>
  50 class Map
  51 :
  52     public HashTable<T, label, Hash<label> >
  53 {
  54
  55 public:
  56
  57     typedef typename HashTable<T, label, Hash<label> >::iterator iterator;
  58
  59     typedef typename HashTable<T, label, Hash<label> >::const_iterator
  60         const_iterator;
  61
  62     // Constructors
  63
  64         //- Construct given initial size
  65         Map(const label size = 128)
  66         :
  67             HashTable<T, label, Hash<label> >(size)
  68         {}
  69
  70         //- Construct from Istream
  71         Map(Istream& is)
  72         :
  73             HashTable<T, label, Hash<label> >(is)
  74         {}
  75
  76         //- Construct as copy
  77         Map(const Map<T>& map)
  78         :
  79             HashTable<T, label, Hash<label> >(map)
  80         {}
  81
  82         //- Construct by transferring the parameter contents
  83         Map(const Xfer<Map<T> >& map)
  84         :
  85             HashTable<T, label, Hash<label> >(map)
  86         {}
  87
  88         //- Construct by transferring the parameter contents
  89         Map(const Xfer<HashTable<T, label, Hash<label> > >& map)
  90         :
  91             HashTable<T, label, Hash<label> >(map)
  92         {}
  93
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //