src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 InNamespace
  25     Foam
  26
  27 Description
  28     Optimized hashing functions.
  29
  30 SeeAlso
  31     Hasher.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef HasherInt_H
  36 #define HasherInt_H
  37
  38 #include "Hasher.H"
  39
  40 #include <cstddef>
  41 #include <stdint.h>    // C++0x uses <cstdint>
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50     //- An optimized version of Hasher
  51     //  \param[in] data - an array of uint32_t values
  52     //  \param[in] length - the number of values (not bytes)
  53     //  \param[in] seed - the previous hash, or an arbitrary value
  54     unsigned HasherInt(const uint32_t* data, size_t length, unsigned seed = 0);
  55
  56     //- An optimized version of Hasher, returning dual hash values
  57     //  \param[in] data - an array of uint32_t values
  58     //  \param[in] length - the number of values (not bytes)
  59     //  \param[in] hash1 - the previous hash, or an arbitrary value
  60     //    on output, the primary hash value
  61     //  \param[in] hash1 - the previous hash, or an arbitrary value
  62     //    on output, the secondary hash value
  63     unsigned HasherDual
  64     (
  65         const uint32_t* data,
  66         size_t length,
  67         unsigned& hash1,
  68         unsigned& hash2
  69     );
  70
  71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  72
  73 } // End namespace Foam
  74
  75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  76
  77 #endif
  78
  79 // ************************************************************************* //