src/IntPolyh/IntPolyh_CoupleMapHasher.hxx

   1 // Created by: Eugeny MALTCHIKOV
   2 // Copyright (c) 2017 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _IntPolyh_CoupleMapHasher_HeaderFile
  16 #define _IntPolyh_CoupleMapHasher_HeaderFile
  17
  18 #include <Standard_Integer.hxx>
  19 #include <IntPolyh_Couple.hxx>
  20
  21 class IntPolyh_Couple;
  22
  23 class IntPolyh_CoupleMapHasher
  24 {
  25 public:
  26
  27   //! Computes a hash code for the given couple, in the range [1, theUpperBound]
  28   //! @param theCouple the couple which hash code is to be computed
  29   //! @param theUpperBound the upper bound of the range a computing hash code must be within
  30   //! @return a computed hash code, in the range [1, theUpperBound]
  31   static Standard_Integer HashCode (const IntPolyh_Couple& theCouple, const Standard_Integer theUpperBound)
  32   {
  33     return theCouple.HashCode (theUpperBound);
  34   }
  35
  36   static Standard_Boolean IsEqual(const IntPolyh_Couple& theCouple1,
  37                                   const IntPolyh_Couple& theCouple2)
  38   {
  39     return theCouple1.IsEqual(theCouple2);
  40   }
  41
  42 protected:
  43
  44 private:
  45
  46 };
  47
  48 #endif // _IntPolyh_CoupleMapHasher_HeaderFile