Adding Frechet distance And Hausdorff distance algorithms to calculate Simmilarity Between Geometries

doc/doxy/doxygen_input/groups/groups.hpp

@@ -6,6 +6,7 @@
 // Modifications copyright (c) 2018, Oracle and/or its affiliates.
 // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
 
+
 // Use, modification and distribution is subject to the Boost Software License,
 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
@@ -32,6 +33,8 @@
 \defgroup cs coordinate systems
 \defgroup densify densify: add points to geometry, keeping shape
 \defgroup difference difference: difference of two geometries
+\defgroup discrete_frechet_distance discrete_frechet_distance : calculate discrete frechet distance between two geometries
+\defgroup discrete_hausdorff_distance discrete_hausdorff_distance : calculate discrete hausdorff distance between two geometries
 \defgroup disjoint disjoint: detect if geometries are not spatially related
 \defgroup distance distance: calculate distance between two geometries
 \defgroup enum enum: enumerations

doc/imports.qbk

@@ -63,6 +63,8 @@
 [import src/examples/algorithms/relation.cpp]
 [import src/examples/algorithms/reverse.cpp]
 [import src/examples/algorithms/return_envelope.cpp]
+[import src/examples/algorithms/discrete_frechet_distance.cpp]
+[import src/examples/algorithms/discrete_hausdorff_distance.cpp]
 [import src/examples/algorithms/simplify.cpp]
 [import src/examples/algorithms/sym_difference.cpp]
 [import src/examples/algorithms/transform.cpp]

doc/make_qbk.py

@@ -8,7 +8,6 @@
 #
 #  Copyright (c) 2018, Oracle and/or its affiliates.
 #  Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
-# 
 #  Use, modification and distribution is subject to the Boost Software License,
 #  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 #  http://www.boost.org/LICENSE_1_0.txt)
@@ -97,12 +96,12 @@ def cs_to_quickbook(section):
 
 algorithms = ["append", "assign", "make", "clear"
     , "area", "buffer", "centroid", "convert", "correct", "covered_by"
-    , "convex_hull", "crosses", "densify", "difference", "disjoint", "distance" 
+    , "convex_hull", "crosses", "densify", "difference", "discrete_frechet_distance","discrete_hausdorff_distance","disjoint", "distance" 
     , "envelope", "equals", "expand", "for_each", "is_empty"
     , "is_simple", "is_valid", "intersection", "intersects", "length"
     , "num_geometries", "num_interior_rings", "num_points"
     , "num_segments", "overlaps", "perimeter", "relate", "relation"
-    , "reverse", "simplify", "sym_difference", "touches"
+    , "reverse","simplify", "sym_difference", "touches"
     , "transform", "union", "unique", "within"]
 
 access_functions = ["get", "set", "exterior_ring", "interior_rings"

doc/quickref.xml

@@ -15,6 +15,9 @@
   Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle
   Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
 
+  Copyright (c) 2018 Yaghyavardhan Singh Khangarot, Hyderabad, India.
+  Contributed and/or modified by Yaghyavardhan Singh Khangarot, as part of Google Summer of Code 2018 program.
+
   Use, modification and distribution is subject to the Boost Software License,
   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
   http://www.boost.org/LICENSE_1_0.txt)
@@ -447,6 +450,11 @@
     <simplelist type="vert" columns="1">
      <member><link linkend="geometry.reference.algorithms.reverse">reverse</link></member>
     </simplelist>
+    <bridgehead renderas="sect3">Similarity</bridgehead>
+    <simplelist type="vert" columns="1">
+     <member><link linkend="geometry.reference.algorithms.discrete_frechet_distance">discrete_frechet_distance</link></member>
+     <member><link linkend="geometry.reference.algorithms.discrete_hausdorff_distance">discrete_hausdorff_distance</link></member>     
+    </simplelist>
     <bridgehead renderas="sect3">Simplify</bridgehead>
     <simplelist type="vert" columns="1">
      <member><link linkend="geometry.reference.algorithms.simplify">simplify</link></member>

doc/reference.qbk

@@ -111,6 +111,14 @@
 [include generated/difference.qbk]
 [endsect]
 
+[section:discrete_frechet_distance discrete_frechet_distance]
+[include generated/discrete_frechet_distance.qbk]
+[endsect]
+
+[section:discrete_hausdorff_distance discrete_hausdorff_distance]
+[include generated/discrete_hausdorff_distance.qbk]
+[endsect]
+
 [section:disjoint disjoint]
 [include generated/disjoint.qbk]
 [endsect]
@@ -184,6 +192,7 @@
 
 [include generated/reverse.qbk]
 
+
 [section:simplify simplify]
 [include generated/simplify.qbk]
 [endsect]

doc/reference/algorithms/discrete_frechet_distance.qbk

@@ -0,0 +1,19 @@
+[/============================================================================
+  Boost.Geometry
+
+  Copyright (c) 2018 Yaghyavardhan Singh Khangarot, Hyderabad, India.
+  Contributed and/or modified by Yaghyavardhan Singh Khangarot, as part of Google Summer of Code 2018 program.
+
+  Use, modification and distribution is subject to the Boost Software License,
+  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+  http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================/]
+
+[def __this_function__ discrete_frechet_distance]
+
+[heading Behavior]
+The algorithm calculate discrete frechet distance between two geometries.
+
+[note The units of the distance depends on strategy. In order to change the
+default behavior a user has to create a strategy and pass it explicitly into
+the algorithm.]

doc/reference/algorithms/discrete_hausdorff_distance.qbk

@@ -0,0 +1,19 @@
+[/============================================================================
+  Boost.Geometry
+
+  Copyright (c) 2018 Yaghyavardhan Singh Khangarot, Hyderabad, India.
+  Contributed and/or modified by Yaghyavardhan Singh Khangarot, as part of Google Summer of Code 2018 program.
+
+  Use, modification and distribution is subject to the Boost Software License,
+  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+  http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================/]
+
+[def __this_function__ discrete_hausdorff_distance]
+
+[heading Behavior]
+The algorithm calculate discrete hausdorff distance between two geometries.
+
+[note The units of the distance depends on strategy. In order to change the
+default behavior a user has to create a strategy and pass it explicitly into
+the algorithm.]

doc/src/examples/algorithms/Jamfile.v2

@@ -43,6 +43,8 @@ exe correct : correct.cpp ;
 
 exe densify : densify.cpp ;
 exe densify_strategy : densify_strategy.cpp ;
+exe discrete_frechet_distance : discrete_frechet_distance.cpp ;
+exe discrete_hausdorff_distance : discrete_hausdorff_distance.cpp ;
 exe difference : difference.cpp ;
 exe distance : distance.cpp ;
 
@@ -85,6 +87,7 @@ exe relation : relation.cpp ;
 
 exe reverse : reverse.cpp ;
 
+
 exe simplify : length.cpp ;
 exe sym_difference : sym_difference.cpp ;
 

doc/src/examples/algorithms/discrete_frechet_distance.cpp

@@ -0,0 +1,35 @@
+// Boost.Geometry
+// QuickBook Example
+// Copyright (c) 2018, Oracle and/or its affiliates
+// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
+// Use, modification and distribution is subject to the Boost Software License,
+// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt)
+
+//[discrete_frechet_distance
+//` Calculate Similarity between two geometries as the discrete frechet distance between them.
+#include <iostream>
+#include <boost/geometry.hpp>
+#include <boost/geometry/geometries/point_xy.hpp>
+#include <boost/geometry/geometries/linestring.hpp>
+int main()
+{
+    typedef boost::geometry::model::d2::point_xy<double> point_type;
+    typedef boost::geometry::model::linestring<point_type> linestring_type;
+    linestring_type linestring1,linestring2;
+    boost::geometry::read_wkt("LINESTRING(0 0,1 1,1 2,2 1,2 2)", linestring1);
+    boost::geometry::read_wkt("LINESTRING(1 0,0 1,1 1,2 1,3 1)", linestring2);    
+    typename distance_result<typename point_type<point_type>::type,typename point_type<linestring_type>::type>::type res;
+    res = boost::geometry::frechet_distance(linestring1,linestrign2);
+    std::cout << "Discrete Frechet Distance: " << res << std::endl;
+    return 0;
+}
+//]
+ //[discrete_frechet_distance_output
+/*`
+Output:
+[pre
+Discrete Frechet Distance:  1.41421
+]
+*/
+//]

doc/src/examples/algorithms/discrete_hausdorff_distance.cpp

@@ -0,0 +1,35 @@
+// Boost.Geometry
+// QuickBook Example
+// Copyright (c) 2018, Oracle and/or its affiliates
+// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
+// Use, modification and distribution is subject to the Boost Software License,
+// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt)
+
+//[discrete_hausdorff_distance
+//` Calculate Similarity between two geometries as the discrete hasdorff distance between them.
+#include <iostream>
+#include <boost/geometry.hpp>
+#include <boost/geometry/geometries/point_xy.hpp>
+#include <boost/geometry/geometries/linestring.hpp>
+int main()
+{
+    typedef boost::geometry::model::d2::point_xy<double> point_type;
+    typedef boost::geometry::model::linestring<point_type> linestring_type;
+    linestring_type linestring1,linestring2;
+    boost::geometry::read_wkt("LINESTRING(0 0,1 1,1 2,2 1,2 2)", linestring1);
+    boost::geometry::read_wkt("LINESTRING(1 0,0 1,1 1,2 1,3 1)", linestring2);    
+    typename distance_result<typename point_type<point_type>::type,typename point_type<linestring_type>::type>::type res;
+    res = boost::geometry::hausdorff_distance(linestring1,linestring2);
+    std::cout << "Discrete Hausdorff Distance: " << res << std::endl;
+    return 0;
+}
+//]
+ //[discrete_hausdorff_distance_output
+/*`
+Output:
+[pre
+Discrete Hausdorff Distance: 1.0
+]
+*/
+//]