centroid_average.qbk 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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/classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.xml]
  12. [section:strategy_centroid_average strategy::centroid::average]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>centroid</primary></indexterm><indexterm><primary>average</primary></indexterm>'''
  14. Centroid calculation taking average of points.
  15. [heading Synopsis]
  16. ``template<typename PointCentroid, typename Point>
  17. class strategy::centroid::average
  18. {
  19. // ...
  20. };
  21. ``
  22. [heading Template parameter(s)]
  23. [table
  24. [[Parameter] [Default] [Description]]
  25. [[typename PointCentroid] [] []]
  26. [[typename Point] [PointCentroid] []]
  27. ]
  28. [heading Member Function(s)]
  29. [table
  30. [[Function] [Description] [Parameters] [Returns]]
  31. [[``void apply(Point const & p, sum & state)``
  32. ] [] [[* Point const &]: ['p]:
  33. [* sum &]: ['state]:
  34. ][
  35. ]
  36. ]
  37. [[``bool result(sum const & state, PointCentroid & centroid)``
  38. ] [] [[* sum const &]: ['state]:
  39. [* PointCentroid &]: ['centroid]:
  40. ][
  41. ]
  42. ]
  43. ]
  44. [heading Header]
  45. `#include <boost/geometry/strategies/cartesian/centroid_average.hpp>`
  46. [endsect]