src/MoniTool/MoniTool_MTHasher.hxx

   1 // Created on: 2001-12-19
   2 // Created by: Sergey KUUL
   3 // Copyright (c) 2001-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _MoniTool_MTHasher_HeaderFile
  17 #define _MoniTool_MTHasher_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_DefineAlloc.hxx>
  21 #include <Standard_Handle.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <Standard_CString.hxx>
  25 #include <Standard_Boolean.hxx>
  26
  27
  28
  29 //! The auxiliary class provides hash code for mapping objects
  30 class MoniTool_MTHasher
  31 {
  32 public:
  33
  34   DEFINE_STANDARD_ALLOC
  35
  36   //! Returns hash code for the given string, in the range [1, theUpperBound]
  37   //! @param theString the string which hash code is to be computed
  38   //! @param theUpperBound the upper bound of the range a computing hash code must be within
  39   //! @return a computed hash code, in the range [1, theUpperBound]
  40   static Standard_Integer HashCode (Standard_CString theString, Standard_Integer theUpperBound);
  41
  42   //! Returns True  when the two CString are the same. Two
  43   //! same strings must have the same hashcode, the
  44   //! contrary is not necessary.
  45   //! Default Str1 == Str2
  46     static Standard_Boolean IsEqual (const Standard_CString Str1, const Standard_CString Str2);
  47
  48
  49
  50
  51 protected:
  52
  53
  54
  55
  56
  57 private:
  58
  59
  60
  61
  62
  63 };
  64
  65
  66 #include <MoniTool_MTHasher.lxx>
  67
  68
  69
  70
  71
  72 #endif // _MoniTool_MTHasher_HeaderFile