OpenFOAM logo
Open Source CFD Toolkit

HashSet.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     HashSet
00027 
00028 Description
00029     HashSet
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef HashSet_H
00034 #define HashSet_H
00035 
00036 #include "HashTable.H"
00037 #include "empty.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class HashSet Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 template<class Key=word, class Hash=string::hash>
00049 class HashSet
00050 :
00051     public HashTable<empty, Key, Hash>
00052 {
00053 
00054 public:
00055 
00056     // Constructors
00057 
00058         //- Construct given initial map size
00059         HashSet(label size = 100)
00060         :
00061             HashTable<empty, Key, Hash>(size)
00062         {}
00063 
00064         //- Construct from Istream
00065         HashSet(Istream& is)
00066         :
00067             HashTable<empty, Key, Hash>(is)
00068         {}
00069 
00070         //- Construct from UList of Key
00071         HashSet(const UList<Key>& ul)
00072         :
00073             HashTable<empty, Key, Hash>(2*ul.size())
00074         {
00075             forAll (ul, i)
00076             {
00077                 insert(ul[i]);
00078             }
00079         }
00080 
00081         //- Construct as copy
00082         HashSet(const HashSet<Key, Hash>& hs)
00083         :
00084             HashTable<empty, Key, Hash>(hs)
00085         {}
00086 
00087 
00088     // Member Functions
00089 
00090         // Edit
00091 
00092             //- Insert a new hashedEntry
00093             bool insert(const Key& key)
00094             {
00095                 return HashTable<empty, Key, Hash>::insert(key, empty());
00096             }
00097 };
00098 
00099 
00100 typedef HashSet<> wordHashSet;
00101 
00102 
00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00104 
00105 } // End namespace Foam
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 #endif
00110 
00111 // ************************************************************************* //
For further information go to www.openfoam.org