1 // Created on: 1993-01-14
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1993-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 _TopTools_ShapeMapHasher_HeaderFile
18 #define _TopTools_ShapeMapHasher_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 TopoDS_Shape;
27 
28 
29 //! Hash tool, used for generating maps of shapes in topology.
30 class TopTools_ShapeMapHasher
31 {
32 public:
33 
34   DEFINE_STANDARD_ALLOC
35 
36   //! Computes a hash code for the given shape, in the range [1, theUpperBound]
37   //! @param theShape the shape 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 (const TopoDS_Shape& theShape, Standard_Integer theUpperBound);
41 
42   //! Returns True  when the two  keys are the same. Two
43   //! same  keys  must   have  the  same  hashcode,  the
44   //! contrary is not necessary.
45     static Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2);
46 
47 
48 
49 
50 protected:
51 
52 
53 
54 
55 
56 private:
57 
58 
59 
60 
61 
62 };
63 
64 
65 #include <TopTools_ShapeMapHasher.lxx>
66 
67 
68 
69 
70 
71 #endif // _TopTools_ShapeMapHasher_HeaderFile
72