for_each.qbk 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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__for__each.xml]
  12. [section:for_each_point for_each_point]
  13. '''<indexterm><primary>for_each_point</primary></indexterm>'''
  14. Applies function [*f] to each point.
  15. [heading Description]
  16. Applies a function [*f] (functor, having operator() defined) to each point making up the geometry
  17. [heading Synopsis]
  18. ``template<typename Geometry, typename Functor>
  19. Functor for_each_point(Geometry & geometry, Functor f)``
  20. [heading Parameters]
  21. [table
  22. [[Type] [Concept] [Name] [Description] ]
  23. [[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
  24. [[Functor] [Function or class with operator()] [f] [Unary function, taking a point as argument ]]
  25. ]
  26. [heading Header]
  27. Either
  28. `#include <boost/geometry.hpp>`
  29. Or
  30. `#include <boost/geometry/algorithms/for_each.hpp>`
  31. [include reference/algorithms/for_each_point.qbk]
  32. [heading Example]
  33. [for_each_point] [for_each_point_output]
  34. [for_each_point_const] [for_each_point_const_output]
  35. [endsect]
  36. [section:for_each_segment for_each_segment]
  37. '''<indexterm><primary>for_each_segment</primary></indexterm>'''
  38. Applies function [*f] to each segment.
  39. [heading Description]
  40. Applies a function [*f] (functor, having operator() defined) to each segment making up the geometry
  41. [heading Synopsis]
  42. ``template<typename Geometry, typename Functor>
  43. Functor for_each_segment(Geometry & geometry, Functor f)``
  44. [heading Parameters]
  45. [table
  46. [[Type] [Concept] [Name] [Description] ]
  47. [[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
  48. [[Functor] [Function or class with operator()] [f] [Unary function, taking a segment as argument ]]
  49. ]
  50. [heading Header]
  51. Either
  52. `#include <boost/geometry.hpp>`
  53. Or
  54. `#include <boost/geometry/algorithms/for_each.hpp>`
  55. [include reference/algorithms/for_each_segment.qbk]
  56. [heading Example]
  57. [for_each_segment_const] [for_each_segment_const_output]
  58. [endsect]