src/OpenFOAM/containers/HashTables/HashSet/HashSet.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::HashSet
  27
  28 Description
  29     A HashTable with word keys but without contents.
  30
  31 Typedef
  32     Foam::wordHashSet
  33
  34 Description
  35     A HashSet with (the default) word keys.
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef HashSet_H
  40 #define HashSet_H
  41
  42 #include "HashTable.H"
  43 #include "empty.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class HashSet Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class Key=word, class Hash=string::hash>
  55 class HashSet
  56 :
  57     public HashTable<empty, Key, Hash>
  58 {
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct given initial map size
  65         HashSet(label size = 100)
  66         :
  67             HashTable<empty, Key, Hash>(size)
  68         {}
  69
  70         //- Construct from Istream
  71         HashSet(Istream& is)
  72         :
  73             HashTable<empty, Key, Hash>(is)
  74         {}
  75
  76         //- Construct from UList of Key
  77         HashSet(const UList<Key>& ul)
  78         :
  79             HashTable<empty, Key, Hash>(2*ul.size())
  80         {
  81             forAll (ul, i)
  82             {
  83                 insert(ul[i]);
  84             }
  85         }
  86
  87         //- Construct as copy
  88         HashSet(const HashSet<Key, Hash>& hs)
  89         :
  90             HashTable<empty, Key, Hash>(hs)
  91         {}
  92
  93
  94     // Member Functions
  95
  96         // Edit
  97
  98             //- Insert a new hashedEntry
  99             bool insert(const Key& key)
 100             {
 101                 return HashTable<empty, Key, Hash>::insert(key, empty());
 102             }
 103 };
 104
 105
 106 typedef HashSet<> wordHashSet;
 107
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 } // End namespace Foam
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 #endif
 116
 117 // ************************************************************************* //