geometry/doc/generated/centroid_average.qbk
Barend Gehrels 9382f261fb Doc update, moved reference/* to generated/* and ref/* to reference/*
doxygen_xml2qbk escaping of underscores

[SVN r69328]
2011-02-27 14:02:14 +00:00

71 lines
1.6 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.xml]
[section:strategy_centroid_average strategy::centroid::average]
Centroid calculation taking average of points.
[heading Synopsis]
``template<typename PointCentroid, typename Point>
class strategy::centroid::average
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[typename PointCentroid] [] []]
[[typename Point] [PointCentroid] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``void apply(Point const & p, sum & state)``
] [] [[* Point const &]: ['p]:
[* sum &]: ['state]:
]]
[[``void result(sum const & state, PointCentroid & centroid)``
] [] [[* sum const &]: ['state]:
[* PointCentroid &]: ['centroid]:
]]
]
[heading Header]
Either
`#include <boost/geometry/multi/multi.hpp>`
Or
`#include <boost/geometry/multi/strategies/cartesian/centroid_average.hpp>`
[endsect]