src/triSurface/tools/hashSignedLabel/hashSignedLabel.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::hashSignedLabel
  26
  27 Description
  28     hash for signed integers (Hash\<label\> only works for unsigned ints)
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef HashSignedLabel_H
  33 #define HashSignedLabel_H
  34
  35 #include "List.H"
  36 #include "word.H"
  37
  38 namespace Foam
  39 {
  40
  41 /*---------------------------------------------------------------------------*\
  42                            Class hashSignedLabel Declaration
  43 \*---------------------------------------------------------------------------*/
  44
  45 class hashSignedLabel
  46 {
  47
  48 public:
  49
  50     hashSignedLabel()
  51     {}
  52
  53
  54     label operator()(const label key, const label tableSize) const
  55     {
  56         return mag(key)%tableSize;
  57     }
  58 };
  59
  60 } // End namespace Foam
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 #endif
  65
  66 // ************************************************************************* //
  67