centroid_bashein_detmer.qbk 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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_1bashein__detmer.xml]
  12. [section:strategy_centroid_bashein_detmer strategy::centroid::bashein_detmer]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>centroid</primary></indexterm><indexterm><primary>bashein_detmer</primary></indexterm>'''
  14. Centroid calculation using algorithm Bashein / Detmer.
  15. [heading Description]
  16. Calculates centroid using triangulation method published by Bashein / Detmer
  17. [heading Synopsis]
  18. ``template<typename Point, typename PointOfSegment, typename CalculationType>
  19. class strategy::centroid::bashein_detmer
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[typename Point] [] [point type of centroid to calculate ]]
  28. [[typename PointOfSegment] [Point] [point type of segments, defaults to Point ]]
  29. [[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point]]
  30. ]
  31. [heading Member Function(s)]
  32. [table
  33. [[Function] [Description] [Parameters] [Returns]]
  34. [[``void apply(PointOfSegment const & p1, PointOfSegment const & p2, sums & state)``
  35. ] [] [[* PointOfSegment const &]: ['p1]:
  36. [* PointOfSegment const &]: ['p2]:
  37. [* sums &]: ['state]:
  38. ][
  39. ]
  40. ]
  41. [[``bool result(sums const & state, Point & centroid)``
  42. ] [] [[* sums const &]: ['state]:
  43. [* Point &]: ['centroid]:
  44. ][
  45. ]
  46. ]
  47. ]
  48. [heading Header]
  49. `#include <boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp>`
  50. [heading See also]
  51. [link geometry.reference.algorithms.centroid.centroid_3_with_strategy centroid (with strategy)]
  52. [endsect]