hashSignedLabel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, 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 
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 // ************************************************************************* //
hash for signed integers (Hash<label> only works for unsigned ints)
label operator()(const label key, const label tableSize) const
dimensioned< scalar > mag(const dimensioned< Type > &)
Namespace for OpenFOAM.