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 held by original author
   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 keys but without contents.
  30
  31 Typedef
  32     Foam::wordHashSet
  33     Foam::labelHashSet
  34
  35 Description
  36     A HashSet with (the default) word keys.
  37
  38 Typedef
  39     Foam::HashSet
  40
  41 Description
  42     A HashSet with default word keys.
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef HashSet_H
  47 #define HashSet_H
  48
  49 #include "HashTable.H"
  50 #include "nil.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                            Class HashSet Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 template<class Key=word, class Hash=string::hash>
  62 class HashSet
  63 :
  64     public HashTable<nil, Key, Hash>
  65 {
  66
  67 public:
  68
  69     typedef typename HashTable<nil, Key, Hash>::iterator iterator;
  70     typedef typename HashTable<nil, Key, Hash>::const_iterator const_iterator;
  71
  72
  73     // Constructors
  74
  75         //- Construct given initial size
  76         explicit HashSet(const label size = 128)
  77         :
  78             HashTable<nil, Key, Hash>(size)
  79         {}
  80
  81         //- Construct from Istream
  82         explicit HashSet(Istream& is)
  83         :
  84             HashTable<nil, Key, Hash>(is)
  85         {}
  86
  87         //- Construct from UList of Key
  88         explicit HashSet(const UList<Key>& lst)
  89         :
  90             HashTable<nil, Key, Hash>(2*lst.size())
  91         {
  92             forAll(lst, i)
  93             {
  94                 insert(lst[i]);
  95             }
  96         }
  97
  98         //- Construct as copy
  99         HashSet(const HashSet<Key, Hash>& hs)
 100         :
 101             HashTable<nil, Key, Hash>(hs)
 102         {}
 103
 104         //- Construct by transferring the parameter contents
 105         explicit HashSet(const Xfer<HashSet<Key, Hash> >& hs)
 106         :
 107             HashTable<nil, Key, Hash>(hs)
 108         {}
 109
 110         //- Construct by transferring the parameter contents
 111         explicit HashSet(const Xfer<HashTable<nil, Key, Hash> >& hs)
 112         :
 113             HashTable<nil, Key, Hash>(hs)
 114         {}
 115
 116         //- Construct from the keys of another HashTable,
 117         //  the type of values held is arbitrary.
 118         template<class AnyType, class AnyHash>
 119         HashSet(const HashTable<AnyType, Key, AnyHash>&);
 120
 121
 122     // Member Functions
 123
 124         // Edit
 125
 126         //- Insert a new entry
 127         bool insert(const Key& key)
 128         {
 129             return HashTable<nil, Key, Hash>::insert(key, nil());
 130         }
 131
 132         //- Same as insert (cannot overwrite nil content)
 133         bool set(const Key& key)
 134         {
 135             return HashTable<nil, Key, Hash>::insert(key, nil());
 136         }
 137
 138
 139     // Member Operators
 140
 141         //- Return true if the entry exists, same as found()
 142         inline bool operator[](const Key&) const;
 143
 144         //- Equality. Two hashtables are equal when their contents are equal.
 145         //  Independent of table size or order.
 146         bool operator==(const HashSet<Key, Hash>&) const;
 147
 148         //- The opposite of the equality operation.
 149         bool operator!=(const HashSet<Key, Hash>&) const;
 150
 151
 152         //- Combine entries from HashSets
 153         void operator|=(const HashSet<Key, Hash>&);
 154
 155         //- Only retain entries found in both HashSets
 156         void operator&=(const HashSet<Key, Hash>&);
 157
 158         //- Only retain unique entries (xor)
 159         void operator^=(const HashSet<Key, Hash>&);
 160
 161         //- Add entries listed in the given HashSet to this HashSet
 162         inline void operator+=(const HashSet<Key, Hash>& rhs)
 163         {
 164             this->operator|=(rhs);
 165         }
 166
 167         //- Remove entries listed in the given HashSet from this HashSet
 168         void operator-=(const HashSet<Key, Hash>&);
 169 };
 170
 171
 172 // Global Operators
 173
 174 //- Combine entries from HashSets
 175 template<class Key, class Hash>
 176 HashSet<Key,Hash> operator|
 177 (
 178     const HashSet<Key,Hash>& hash1,
 179     const HashSet<Key,Hash>& hash2
 180 );
 181
 182
 183 //- Create a HashSet that only contains entries found in both HashSets
 184 template<class Key, class Hash>
 185 HashSet<Key,Hash> operator&
 186 (
 187     const HashSet<Key,Hash>& hash1,
 188     const HashSet<Key,Hash>& hash2
 189 );
 190
 191
 192 //- Create a HashSet that only contains unique entries (xor)
 193 template<class Key, class Hash>
 194 HashSet<Key,Hash> operator^
 195 (
 196     const HashSet<Key,Hash>& hash1,
 197     const HashSet<Key,Hash>& hash2
 198 );
 199
 200
 201 //- A HashSet with word keys.
 202 typedef HashSet<> wordHashSet;
 203
 204 //- A HashSet with label keys.
 205 typedef HashSet<label, Hash<label> > labelHashSet;
 206
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 } // End namespace Foam
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #ifdef NoRepository
 215 #   include "HashSet.C"
 216 #endif
 217
 218 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 219
 220 #endif
 221
 222 // ************************************************************************* //