FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

hashSignedLabel.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::hashSignedLabel
00026 
00027 Description
00028     hash for signed integers (Hash<label> only works for unsigned ints)
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef HashSignedLabel_H
00033 #define HashSignedLabel_H
00034 
00035 #include <OpenFOAM/List.H>
00036 #include <OpenFOAM/word.H>
00037 
00038 namespace Foam
00039 {
00040 
00041 /*---------------------------------------------------------------------------*\
00042                            Class hashSignedLabel Declaration
00043 \*---------------------------------------------------------------------------*/
00044 
00045 class hashSignedLabel
00046 {
00047 
00048 public:
00049 
00050     hashSignedLabel()
00051     {}
00052 
00053 
00054     label operator()(const label key, const label tableSize) const
00055     {
00056         return mag(key)%tableSize;
00057     }
00058 };
00059 
00060 } // End namespace Foam
00061 
00062 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00063 
00064 #endif
00065 
00066 // ************************ vim: set sw=4 sts=4 et: ************************ //
00067 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines