equals.qbk 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  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__equals.xml]
  12. [section:equals_3_with_strategy equals (with strategy)]
  13. '''<indexterm><primary>equals</primary></indexterm>'''
  14. Checks if a geometry are spatially equal.
  15. [heading Description]
  16. The free function equals checks if the first geometry is spatially equal the second geometry. Spatially equal means that the same point set is included. A box can therefore be spatially equal to a ring or a polygon, or a linestring can be spatially equal to a multi-linestring or a segment. This only works theoretically, not all combinations are implemented yet.
  17. [heading Synopsis]
  18. ``template<typename Geometry1, typename Geometry2, typename Strategy>
  19. bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
  20. [heading Parameters]
  21. [table
  22. [[Type] [Concept] [Name] [Description] ]
  23. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  24. [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  25. [[Strategy const &] [Any type fulfilling a Equals Strategy Concept ] [strategy] [The strategy which will be used for equals calculations ]]
  26. ]
  27. [heading Returns]
  28. Returns true if two geometries are spatially equal
  29. [heading Header]
  30. Either
  31. `#include <boost/geometry.hpp>`
  32. Or
  33. `#include <boost/geometry/algorithms/equals.hpp>`
  34. [include reference/algorithms/equals.qbk]
  35. [endsect]
  36. [section:equals_2 equals]
  37. '''<indexterm><primary>equals</primary></indexterm>'''
  38. Checks if a geometry are spatially equal.
  39. [heading Description]
  40. The free function equals checks if the first geometry is spatially equal the second geometry. Spatially equal means that the same point set is included. A box can therefore be spatially equal to a ring or a polygon, or a linestring can be spatially equal to a multi-linestring or a segment. This only works theoretically, not all combinations are implemented yet.
  41. [heading Synopsis]
  42. ``template<typename Geometry1, typename Geometry2>
  43. bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2)``
  44. [heading Parameters]
  45. [table
  46. [[Type] [Concept] [Name] [Description] ]
  47. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  48. [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  49. ]
  50. [heading Returns]
  51. Returns true if two geometries are spatially equal
  52. [heading Header]
  53. Either
  54. `#include <boost/geometry.hpp>`
  55. Or
  56. `#include <boost/geometry/algorithms/equals.hpp>`
  57. [include reference/algorithms/equals.qbk]
  58. [endsect]