src/Interface/Interface_MapAsciiStringHasher.hxx

   1 // Created on: 2003-05-06
   2 // Created by: Galina KULIKOVA
   3 // Copyright (c) 2003-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 _Interface_MapAsciiStringHasher_HeaderFile
  17 #define _Interface_MapAsciiStringHasher_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_Boolean.hxx>
  25 class TCollection_AsciiString;
  26
  27
  28
  29 class Interface_MapAsciiStringHasher
  30 {
  31 public:
  32
  33   DEFINE_STANDARD_ALLOC
  34
  35   //! Computes a hash code for the given ASCII string, in the range [1, theUpperBound]
  36   //! @param theAsciiString the ASCII string which hash code is to be computed
  37   //! @param theUpperBound the upper bound of the range a computing hash code must be within
  38   //! @return a computed hash code, in the range [1, theUpperBound]
  39   Standard_EXPORT static Standard_Integer HashCode (const TCollection_AsciiString& theAsciiString,
  40                                                     Standard_Integer               theUpperBound);
  41
  42   Standard_EXPORT static Standard_Boolean IsEqual (const TCollection_AsciiString& K1, const TCollection_AsciiString& K2);
  43
  44
  45
  46
  47 protected:
  48
  49
  50
  51
  52
  53 private:
  54
  55
  56
  57
  58
  59 };
  60
  61
  62
  63
  64
  65
  66
  67 #endif // _Interface_MapAsciiStringHasher_HeaderFile