src/MoniTool/MoniTool_ElemHasher.hxx

   1 // Created on: 1994-11-04
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1994-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _MoniTool_ElemHasher_HeaderFile
  18 #define _MoniTool_ElemHasher_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Integer.hxx>
  25 #include <Standard_Boolean.hxx>
  26 class MoniTool_Element;
  27
  28
  29 //! ElemHasher defines HashCode for Element, which is : ask a
  30 //! Element its HashCode !  Because this is the Element itself
  31 //! which brings the HashCode for its Key
  32 //!
  33 //! This class complies to the template given in TCollection by
  34 //! MapHasher itself
  35 class MoniTool_ElemHasher
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41   //! Returns hash code for the given element, in the range [1, theUpperBound].
  42   //! Asks theElement its HashCode, then transforms it to be in the required range.
  43   //! @param theElement the element which hash code is to be computed
  44   //! @param theUpperBound the upper bound of the range a computing hash code must be within
  45   //! @return a computed hash code, in the range [1, theUpperBound]
  46   Standard_EXPORT static Standard_Integer HashCode (const Handle (MoniTool_Element) & theElement,
  47                                                     Standard_Integer                  theUpperBound);
  48
  49   //! Returns True if two keys are the same.
  50   //! The test does not work on the Elements themselves but by
  51   //! calling their methods Equates
  52   Standard_EXPORT static Standard_Boolean IsEqual (const Handle(MoniTool_Element)& K1, const Handle(MoniTool_Element)& K2);
  53
  54
  55
  56
  57 protected:
  58
  59
  60
  61
  62
  63 private:
  64
  65
  66
  67
  68
  69 };
  70
  71
  72
  73
  74
  75
  76
  77 #endif // _MoniTool_ElemHasher_HeaderFile