intersection.qbk 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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__intersection.xml]
  12. [section:intersection_4_with_strategy intersection (with strategy)]
  13. '''<indexterm><primary>intersection</primary></indexterm>'''
  14. Calculate the intersection of two geometries.
  15. [heading Description]
  16. The free function intersection calculates the spatial set theoretic intersection of two geometries.
  17. [heading Synopsis]
  18. ``template<typename Geometry1, typename Geometry2, typename GeometryOut, typename Strategy>
  19. bool intersection(Geometry1 const & geometry1, Geometry2 const & geometry2, GeometryOut & geometry_out,
  20. Strategy const & strategy)``
  21. [heading Parameters]
  22. [table
  23. [[Type] [Concept] [Name] [Description] ]
  24. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  25. [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  26. [[GeometryOut &] [Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*) of which the value_type fulfills a Point, LineString or Polygon concept, or it is the output geometry (e.g. for a box) ] [geometry_out] [The output geometry, either a multi_point, multi_polygon, multi_linestring, or a box (for intersection of two boxes) ]]
  27. [[Strategy const &] [Any type fulfilling a Intersection Strategy Concept ] [strategy] [The strategy which will be used for intersection calculations]]
  28. ]
  29. [heading Header]
  30. Either
  31. `#include <boost/geometry.hpp>`
  32. Or
  33. `#include <boost/geometry/algorithms/intersection.hpp>`
  34. [include reference/algorithms/intersection.qbk]
  35. [endsect]
  36. [section:intersection_3 intersection]
  37. '''<indexterm><primary>intersection</primary></indexterm>'''
  38. Calculate the intersection of two geometries.
  39. [heading Description]
  40. The free function intersection calculates the spatial set theoretic intersection of two geometries.
  41. [heading Synopsis]
  42. ``template<typename Geometry1, typename Geometry2, typename GeometryOut>
  43. bool intersection(Geometry1 const & geometry1, Geometry2 const & geometry2, GeometryOut & geometry_out)``
  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. [[GeometryOut &] [Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*) of which the value_type fulfills a Point, LineString or Polygon concept, or it is the output geometry (e.g. for a box) ] [geometry_out] [The output geometry, either a multi_point, multi_polygon, multi_linestring, or a box (for intersection of two boxes)]]
  50. ]
  51. [heading Header]
  52. Either
  53. `#include <boost/geometry.hpp>`
  54. Or
  55. `#include <boost/geometry/algorithms/intersection.hpp>`
  56. [include reference/algorithms/intersection.qbk]
  57. [endsect]