OpenFOAM logo
Open Source CFD Toolkit

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-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     HashSignedLabel
00027 
00028 Description
00029     hash for signed integers (Hash<label> only works for unsigned ints)
00030 
00031 SourceFiles
00032     HashSignedLabel.H
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef HashSignedLabel_H
00037 #define HashSignedLabel_H
00038 
00039 #include "List.H"
00040 #include "word.H"
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class hashSignedLabel Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class hashSignedLabel
00050 {
00051 
00052 public:
00053 
00054     hashSignedLabel()
00055     {}
00056 
00057 
00058     label operator()(const label key, const label tableSize) const
00059     {
00060         return mag(key)%tableSize;
00061     }
00062 };
00063 
00064 } // End namespace Foam
00065 
00066 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00067 
00068 #endif
00069 
00070 // ************************************************************************* //
00071 
For further information go to www.openfoam.org