src/OpenFOAM/primitives/Hash/Hash.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::Hash
  27
  28 Description
  29     Hash function class for primitives.  All non-primitives used to hash
  30     entries on hash tables need a specialised version of this class.
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef Hash_H
  35 #define Hash_H
  36
  37 #include "label.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class Hash Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 template<class primitive>
  49 class Hash
  50 {
  51
  52 public:
  53
  54     Hash()
  55     {}
  56
  57     label operator()(const primitive& p) const
  58     {
  59         return label(p);
  60     }
  61
  62     label operator()(const primitive& p, const label tableSize) const
  63     {
  64         return mag(operator()(p)) % tableSize;
  65     }
  66 };
  67
  68
  69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  70
  71 } // End namespace Foam
  72
  73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  74
  75 #endif
  76
  77 // ************************************************************************* //