expand.qbk 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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__expand.xml]
  12. [section:expand_3_with_strategy expand (with strategy)]
  13. '''<indexterm><primary>expand</primary></indexterm>'''
  14. Expands (with strategy)
  15. [heading Synopsis]
  16. ``template<typename Box, typename Geometry, typename Strategy>
  17. void expand(Box & box, Geometry const & geometry, Strategy const & strategy)``
  18. [heading Parameters]
  19. [table
  20. [[Type] [Concept] [Name] [Description] ]
  21. [[Box &] [type of the box ] [box] [box to be expanded using another geometry, mutable ]]
  22. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept geometry which envelope (bounding box) ]]
  23. [[Strategy const &] [Any type fulfilling a expand Strategy Concept ] [strategy] [The strategy which will be used for expand calculations will be added to the box]]
  24. ]
  25. [heading Header]
  26. Either
  27. `#include <boost/geometry.hpp>`
  28. Or
  29. `#include <boost/geometry/algorithms/expand.hpp>`
  30. [include reference/algorithms/expand.qbk]
  31. [endsect]
  32. [section:expand_2 expand]
  33. '''<indexterm><primary>expand</primary></indexterm>'''
  34. Expands a box using the bounding box (envelope) of another geometry (box, point)
  35. [heading Synopsis]
  36. ``template<typename Box, typename Geometry>
  37. void expand(Box & box, Geometry const & geometry)``
  38. [heading Parameters]
  39. [table
  40. [[Type] [Concept] [Name] [Description] ]
  41. [[Box &] [type of the box ] [box] [box to be expanded using another geometry, mutable ]]
  42. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept geometry which envelope (bounding box) will be added to the box]]
  43. ]
  44. [heading Header]
  45. Either
  46. `#include <boost/geometry.hpp>`
  47. Or
  48. `#include <boost/geometry/algorithms/expand.hpp>`
  49. [include reference/algorithms/expand.qbk]
  50. [endsect]