mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-11 13:34:10 +00:00
71 lines
2.0 KiB
Plaintext
71 lines
2.0 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_1area_1_1surveyor.xml]
|
|
[section:strategy_area_surveyor strategy::area::surveyor]
|
|
|
|
Area calculation for cartesian points.
|
|
|
|
[heading Description]
|
|
Calculates area using the Surveyor's formula, a well-known triangulation algorithm
|
|
|
|
[heading Synopsis]
|
|
``template<typename PointOfSegment, typename CalculationType>
|
|
class strategy::area::surveyor
|
|
{
|
|
// ...
|
|
};
|
|
``
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Default] [Description]]
|
|
[[typename PointOfSegment] [] [segment point type ]]
|
|
[[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]]
|
|
]
|
|
|
|
[heading Member Function(s)]
|
|
[table
|
|
[[Function] [Description] [Parameters] [Returns]]
|
|
[[``void apply(PointOfSegment const & p1, PointOfSegment const & p2, summation & state)``
|
|
|
|
] [] [[* PointOfSegment const &]: ['p1]:
|
|
|
|
[* PointOfSegment const &]: ['p2]:
|
|
|
|
[* summation &]: ['state]:
|
|
|
|
|
|
|
|
|
|
]]
|
|
[[``return_type result(summation const & state)``
|
|
|
|
] [] [[* summation const &]: ['state]:
|
|
|
|
|
|
|
|
|
|
]]
|
|
]
|
|
|
|
[heading Header]
|
|
`#include <boost/geometry/strategies/cartesian/area_surveyor.hpp>`
|
|
|
|
[heading See also]
|
|
[link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
|
|
|
|
[endsect]
|
|
|