libs/geometry/doc/html/geometry/reference/strategies/strategy_area_surveyor.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::area::surveyor</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../strategies.html" title="Strategies">
   9 <link rel="prev" href="strategy_distance_cross_track.html" title="strategy::distance::cross_track">
  10 <link rel="next" href="strategy_area_huiller.html" title="strategy::area::huiller">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <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>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp133561936"></a><a class="indexterm" name="idp133562624"></a><a class="indexterm" name="idp133563312"></a>
  31 Area calculation for cartesian points.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_area_surveyor.h0"></a>
  35           <span class="phrase"><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>
  36         </h6>
  37 <p>
  38           Calculates area using the Surveyor's formula, a well-known triangulation
  39           algorithm
  40         </p>
  41 <h6>
  42 <a name="geometry.reference.strategies.strategy_area_surveyor.h1"></a>
  43           <span class="phrase"><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>
  44         </h6>
  45 <p>
  46 </p>
  47 <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>
  48 <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>
  49 <span class="special">{</span>
  50   <span class="comment">// ...</span>
  51 <span class="special">};</span>
  52 </pre>
  53 <p>
  54         </p>
  55 <h6>
  56 <a name="geometry.reference.strategies.strategy_area_surveyor.h2"></a>
  57           <span class="phrase"><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
  58           parameter(s)</a>
  59         </h6>
  60 <div class="informaltable"><table class="table">
  61 <colgroup>
  62 <col>
  63 <col>
  64 <col>
  65 </colgroup>
  66 <thead><tr>
  67 <th>
  68                   <p>
  69                     Parameter
  70                   </p>
  71                 </th>
  72 <th>
  73                   <p>
  74                     Default
  75                   </p>
  76                 </th>
  77 <th>
  78                   <p>
  79                     Description
  80                   </p>
  81                 </th>
  82 </tr></thead>
  83 <tbody>
  84 <tr>
  85 <td>
  86                   <p>
  87                     typename PointOfSegment
  88                   </p>
  89                 </td>
  90 <td>
  91                 </td>
  92 <td>
  93                   <p>
  94                     segment point type
  95                   </p>
  96                 </td>
  97 </tr>
  98 <tr>
  99 <td>
 100                   <p>
 101                     typename CalculationType
 102                   </p>
 103                 </td>
 104 <td>
 105                   <p>
 106                     void
 107                   </p>
 108                 </td>
 109 <td>
 110                   <p>
 111                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
 112                     from the coordinate type and (if necessary) promoted to floating
 113                     point
 114                   </p>
 115                 </td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 <h6>
 120 <a name="geometry.reference.strategies.strategy_area_surveyor.h3"></a>
 121           <span class="phrase"><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
 122           Function(s)</a>
 123         </h6>
 124 <div class="informaltable"><table class="table">
 125 <colgroup>
 126 <col>
 127 <col>
 128 <col>
 129 <col>
 130 </colgroup>
 131 <thead><tr>
 132 <th>
 133                   <p>
 134                     Function
 135                   </p>
 136                 </th>
 137 <th>
 138                   <p>
 139                     Description
 140                   </p>
 141                 </th>
 142 <th>
 143                   <p>
 144                     Parameters
 145                   </p>
 146                 </th>
 147 <th>
 148                   <p>
 149                     Returns
 150                   </p>
 151                 </th>
 152 </tr></thead>
 153 <tbody>
 154 <tr>
 155 <td>
 156                   <p>
 157 </p>
 158 <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>
 159 <p>
 160                   </p>
 161                 </td>
 162 <td>
 163                 </td>
 164 <td>
 165                   <p>
 166                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 167                     <span class="emphasis"><em>p1</em></span>:
 168                   </p>
 169                   <p>
 170                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 171                     <span class="emphasis"><em>p2</em></span>:
 172                   </p>
 173                   <p>
 174                     <span class="bold"><strong>summation &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 175                   </p>
 176                 </td>
 177 <td>
 178                 </td>
 179 </tr>
 180 <tr>
 181 <td>
 182                   <p>
 183 </p>
 184 <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>
 185 <p>
 186                   </p>
 187                 </td>
 188 <td>
 189                 </td>
 190 <td>
 191                   <p>
 192                     <span class="bold"><strong>summation const &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 193                   </p>
 194                 </td>
 195 <td>
 196                 </td>
 197 </tr>
 198 </tbody>
 199 </table></div>
 200 <h6>
 201 <a name="geometry.reference.strategies.strategy_area_surveyor.h4"></a>
 202           <span class="phrase"><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>
 203         </h6>
 204 <p>
 205           <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>
 206         </p>
 207 <h6>
 208 <a name="geometry.reference.strategies.strategy_area_surveyor.h5"></a>
 209           <span class="phrase"><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
 210           also</a>
 211         </h6>
 212 <p>
 213           <a class="link" href="../algorithms/area/area_2_with_strategy.html" title="area (with strategy)">area
 214           (with strategy)</a>
 215         </p>
 216 </div>
 217 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 218 <td align="left"></td>
 219 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 220       Wulkiewicz, Oracle and/or its affiliates<p>
 221         Distributed under the Boost Software License, Version 1.0. (See accompanying
 222         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>)
 223       </p>
 224 </div></td>
 225 </tr></table>
 226 <hr>
 227 <div class="spirit-nav">
 228 <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>
 229 </div>
 230 </body>
 231 </html>