discrete_hausdorff_distance.qbk 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/group__discrete__hausdorff__distance.xml]
  12. [section:discrete_hausdorff_distance_3_with_strategy discrete_hausdorff_distance (with strategy)]
  13. '''<indexterm><primary>discrete_hausdorff_distance</primary></indexterm>'''
  14. Calculate discrete Hausdorff distance between two geometries (currently works for LineString-LineString, MultiPoint-MultiPoint, Point-MultiPoint, MultiLineString-MultiLineString) using specified strategy.
  15. [heading Synopsis]
  16. ``template<typename Geometry1, typename Geometry2, typename Strategy>
  17. distance_result< typename point_type<Geometry1>::type, typename point_type<Geometry2>::type, Strategy >::type discrete_hausdorff_distance(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
  18. [heading Parameters]
  19. [table
  20. [[Type] [Concept] [Name] [Description] ]
  21. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [Input geometry ]]
  22. [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [Input geometry ]]
  23. [[Strategy const &] [A type fulfilling a DistanceStrategy concept ] [strategy] [Distance strategy to be used to calculate Pt-Pt distance]]
  24. ]
  25. [heading Header]
  26. Either
  27. `#include <boost/geometry.hpp>`
  28. Or
  29. `#include <boost/geometry/algorithms/discrete_hausdorff_distance.hpp>`
  30. [include reference/algorithms/discrete_hausdorff_distance.qbk]
  31. [heading Available Strategies]
  32. * [link geometry.reference.strategies.strategy_distance_pythagoras Pythagoras (cartesian)]
  33. * [link geometry.reference.strategies.strategy_distance_haversine Haversine (spherical)]
  34. [/ * more (currently extensions): Vincenty, Andoyer (geographic) ]
  35. [heading Example]
  36. [discrete_hausdorff_distance_strategy]
  37. [discrete_hausdorff_distance_strategy_output]
  38. [endsect]
  39. [section:discrete_hausdorff_distance_2 discrete_hausdorff_distance]
  40. '''<indexterm><primary>discrete_hausdorff_distance</primary></indexterm>'''
  41. Calculate discrete Hausdorff distance between two geometries (currently works for LineString-LineString, MultiPoint-MultiPoint, Point-MultiPoint, MultiLineString-MultiLineString).
  42. [heading Synopsis]
  43. ``template<typename Geometry1, typename Geometry2>
  44. distance_result< typename point_type<Geometry1>::type, typename point_type<Geometry2>::type >::type discrete_hausdorff_distance(Geometry1 const & geometry1, Geometry2 const & geometry2)``
  45. [heading Parameters]
  46. [table
  47. [[Type] [Concept] [Name] [Description] ]
  48. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [Input geometry ]]
  49. [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [Input geometry]]
  50. ]
  51. [heading Header]
  52. Either
  53. `#include <boost/geometry.hpp>`
  54. Or
  55. `#include <boost/geometry/algorithms/discrete_hausdorff_distance.hpp>`
  56. [include reference/algorithms/discrete_hausdorff_distance.qbk]
  57. [heading Example]
  58. [discrete_hausdorff_distance]
  59. [discrete_hausdorff_distance_output]
  60. [endsect]