summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html
diff options
context:
space:
mode:
Diffstat (limited to 'libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html')
-rwxr-xr-xlibs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html226
1 files changed, 226 insertions, 0 deletions
diff --git a/libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html b/libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html
new file mode 100755
index 0000000000..ae2d099a8d
--- /dev/null
+++ b/libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html
@@ -0,0 +1,226 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>strategy::area::surveyor</title>
+<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
+<link rel="up" href="../strategies.html" title="Strategies">
+<link rel="prev" href="strategy_distance_cross_track.html" title="strategy::distance::cross_track">
+<link rel="next" href="strategy_area_huiller.html" title="strategy::area::huiller">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
+<td align="center"><a href="../../../../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="strategy_distance_cross_track.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_area_huiller.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="geometry.reference.strategies.strategy_area_surveyor"></a><a class="link" href="strategy_area_surveyor.html" title="strategy::area::surveyor">strategy::area::surveyor</a>
+</h4></div></div></div>
+<p>
+ <a class="indexterm" name="id960374"></a><a class="indexterm" name="id960380"></a><a class="indexterm" name="id960386"></a>
+Area calculation for cartesian points.
+ </p>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h0"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.description"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.description">Description</a>
+ </h6>
+<p>
+ Calculates area using the Surveyor's formula, a well-known triangulation
+ algorithm
+ </p>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h1"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.synopsis"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.synopsis">Synopsis</a>
+ </h6>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">PointOfSegment</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">CalculationType</span><span class="special">&gt;</span>
+<span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">area</span><span class="special">::</span><span class="identifier">surveyor</span>
+<span class="special">{</span>
+ <span class="comment">// ...</span>
+<span class="special">};</span>
+</pre>
+<p>
+ </p>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h2"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.template_parameter_s_"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Default
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ typename PointOfSegment
+ </p>
+ </td>
+<td>
+ </td>
+<td>
+ <p>
+ segment point type
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ typename CalculationType
+ </p>
+ </td>
+<td>
+ <p>
+ void
+ </p>
+ </td>
+<td>
+ <p>
+ numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
+ from the coordinate type and (if necessary) promoted to floating
+ point
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h3"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.member_function_s_"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.member_function_s_">Member
+ Function(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Function
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Parameters
+ </p>
+ </th>
+<th>
+ <p>
+ Returns
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+</p>
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">apply</span><span class="special">(</span><span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p2</span><span class="special">,</span> <span class="identifier">summation</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
+<p>
+ </p>
+ </td>
+<td>
+ </td>
+<td>
+ <p>
+ <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
+ <span class="emphasis"><em>p1</em></span>:
+ </p>
+ <p>
+ <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
+ <span class="emphasis"><em>p2</em></span>:
+ </p>
+ <p>
+ <span class="bold"><strong>summation &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+</p>
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">return_type</span> <span class="identifier">result</span><span class="special">(</span><span class="identifier">summation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
+<p>
+ </p>
+ </td>
+<td>
+ </td>
+<td>
+ <p>
+ <span class="bold"><strong>summation const &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h4"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.header"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.header">Header</a>
+ </h6>
+<p>
+ <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">strategies</span><span class="special">/</span><span class="identifier">cartesian</span><span class="special">/</span><span class="identifier">area_surveyor</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
+ </p>
+<h6>
+<a name="geometry.reference.strategies.strategy_area_surveyor.h5"></a>
+ <span><a name="geometry.reference.strategies.strategy_area_surveyor.see_also"></a></span><a class="link" href="strategy_area_surveyor.html#geometry.reference.strategies.strategy_area_surveyor.see_also">See
+ also</a>
+ </h6>
+<p>
+ <a class="link" href="../algorithms/area/area_2_with_strategy.html" title="area (with strategy)">area
+ (with strategy)</a>
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Barend
+ Gehrels, Bruno Lalande, Mateusz Loskot<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="strategy_distance_cross_track.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_area_huiller.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>