• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.xml]
16[section:strategy_centroid_average strategy::centroid::average]
17
18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>centroid</primary></indexterm><indexterm><primary>average</primary></indexterm>'''
19Centroid calculation taking average of points.
20
21[heading Synopsis]
22``template<typename PointCentroid, typename Point>
23class strategy::centroid::average
24{
25  // ...
26};
27``
28
29[heading Template parameter(s)]
30[table
31[[Parameter] [Default] [Description]]
32[[typename PointCentroid] [] []]
33[[typename Point] [PointCentroid] []]
34]
35
36[heading Member Function(s)]
37[table
38[[Function] [Description] [Parameters]  [Returns]]
39[[``void apply(Point const & p, sum & state)``
40
41] [] [[* Point const &]: ['p]:
42
43[* sum &]: ['state]:
44
45
46
47][
48
49]
50]
51[[``bool result(sum const & state, PointCentroid & centroid)``
52
53] [] [[* sum const &]: ['state]:
54
55[* PointCentroid &]: ['centroid]:
56
57
58
59][
60
61]
62]
63]
64
65[heading Header]
66`#include <boost/geometry/strategies/cartesian/centroid_average.hpp>`
67
68[endsect]
69
70