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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::area::spherical</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.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_area_cartesian.html" title="strategy::area::cartesian">
  10 <link rel="next" href="strategy_area_geographic.html" title="strategy::area::geographic">
  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_area_cartesian.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_geographic.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_spherical"></a><a class="link" href="strategy_area_spherical.html" title="strategy::area::spherical">strategy::area::spherical</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186975499104"></a><a class="indexterm" name="idm46186975498416"></a><a class="indexterm" name="idm46186975497728"></a>
  31 Spherical area calculation.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_area_spherical.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.description"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.description">Description</a>
  36         </h6>
  37 <p>
  38           Calculates area on the surface of a sphere using the trapezoidal rule
  39         </p>
  40 <h6>
  41 <a name="geometry.reference.strategies.strategy_area_spherical.h1"></a>
  42           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.synopsis"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.synopsis">Synopsis</a>
  43         </h6>
  44 <p>
  45 </p>
  46 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">RadiusTypeOrSphere</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">CalculationType</span><span class="special">&gt;</span>
  47 <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">spherical</span>
  48 <span class="special">{</span>
  49   <span class="comment">// ...</span>
  50 <span class="special">};</span>
  51 </pre>
  52 <p>
  53         </p>
  54 <h6>
  55 <a name="geometry.reference.strategies.strategy_area_spherical.h2"></a>
  56           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.template_parameter_s_"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.template_parameter_s_">Template
  57           parameter(s)</a>
  58         </h6>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                   <p>
  68                     Parameter
  69                   </p>
  70                 </th>
  71 <th>
  72                   <p>
  73                     Default
  74                   </p>
  75                 </th>
  76 <th>
  77                   <p>
  78                     Description
  79                   </p>
  80                 </th>
  81 </tr></thead>
  82 <tbody>
  83 <tr>
  84 <td>
  85                   <p>
  86                     typename RadiusTypeOrSphere
  87                   </p>
  88                 </td>
  89 <td>
  90                   <p>
  91                     double
  92                   </p>
  93                 </td>
  94 <td>
  95                   <p>
  96                     numeric type for radius (of sphere, earth) or sphere model
  97                   </p>
  98                 </td>
  99 </tr>
 100 <tr>
 101 <td>
 102                   <p>
 103                     typename CalculationType
 104                   </p>
 105                 </td>
 106 <td>
 107                   <p>
 108                     void
 109                   </p>
 110                 </td>
 111 <td>
 112                   <p>
 113                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
 114                     from the coordinate type and (if necessary) promoted to floating
 115                     point
 116                   </p>
 117                 </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 <h6>
 122 <a name="geometry.reference.strategies.strategy_area_spherical.h3"></a>
 123           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.constructor_s_"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.constructor_s_">Constructor(s)</a>
 124         </h6>
 125 <div class="informaltable"><table class="table">
 126 <colgroup>
 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 </tr></thead>
 148 <tbody>
 149 <tr>
 150 <td>
 151                   <p>
 152 </p>
 153 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">spherical</span><span class="special">()</span></pre>
 154 <p>
 155                   </p>
 156                 </td>
 157 <td>
 158                 </td>
 159 <td>
 160                 </td>
 161 </tr>
 162 <tr>
 163 <td>
 164                   <p>
 165 </p>
 166 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">RadiusOrSphere</span><span class="special">&gt;</span>
 167 <span class="identifier">spherical</span><span class="special">(</span><span class="identifier">RadiusOrSphere</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">radius_or_sphere</span><span class="special">)</span></pre>
 168 <p>
 169                   </p>
 170                 </td>
 171 <td>
 172                 </td>
 173 <td>
 174                   <p>
 175                     <span class="bold"><strong>RadiusOrSphere const &amp;</strong></span>:
 176                     <span class="emphasis"><em>radius_or_sphere</em></span>:
 177                   </p>
 178                 </td>
 179 </tr>
 180 </tbody>
 181 </table></div>
 182 <h6>
 183 <a name="geometry.reference.strategies.strategy_area_spherical.h4"></a>
 184           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.member_function_s_"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.member_function_s_">Member
 185           Function(s)</a>
 186         </h6>
 187 <div class="informaltable"><table class="table">
 188 <colgroup>
 189 <col>
 190 <col>
 191 <col>
 192 <col>
 193 </colgroup>
 194 <thead><tr>
 195 <th>
 196                   <p>
 197                     Function
 198                   </p>
 199                 </th>
 200 <th>
 201                   <p>
 202                     Description
 203                   </p>
 204                 </th>
 205 <th>
 206                   <p>
 207                     Parameters
 208                   </p>
 209                 </th>
 210 <th>
 211                   <p>
 212                     Returns
 213                   </p>
 214                 </th>
 215 </tr></thead>
 216 <tbody>
 217 <tr>
 218 <td>
 219                   <p>
 220 </p>
 221 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-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">Geometry</span><span class="special">&gt;</span>
 222 <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">state</span><span class="special">&lt;</span> <span class="identifier">Geometry</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">st</span><span class="special">)</span></pre>
 223 <p>
 224                   </p>
 225                 </td>
 226 <td>
 227                 </td>
 228 <td>
 229                   <p>
 230                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 231                     <span class="emphasis"><em>p1</em></span>:
 232                   </p>
 233                   <p>
 234                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 235                     <span class="emphasis"><em>p2</em></span>:
 236                   </p>
 237                   <p>
 238                     <span class="bold"><strong>state&lt; Geometry &gt; &amp;</strong></span>:
 239                     <span class="emphasis"><em>st</em></span>:
 240                   </p>
 241                 </td>
 242 <td>
 243                 </td>
 244 </tr>
 245 <tr>
 246 <td>
 247                   <p>
 248 </p>
 249 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
 250 <span class="identifier">result_type</span><span class="special">&lt;</span> <span class="identifier">Geometry</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">result</span><span class="special">(</span><span class="identifier">state</span><span class="special">&lt;</span> <span class="identifier">Geometry</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">st</span><span class="special">)</span></pre>
 251 <p>
 252                   </p>
 253                 </td>
 254 <td>
 255                 </td>
 256 <td>
 257                   <p>
 258                     <span class="bold"><strong>state&lt; Geometry &gt; const &amp;</strong></span>:
 259                     <span class="emphasis"><em>st</em></span>:
 260                   </p>
 261                 </td>
 262 <td>
 263                 </td>
 264 </tr>
 265 </tbody>
 266 </table></div>
 267 <h6>
 268 <a name="geometry.reference.strategies.strategy_area_spherical.h5"></a>
 269           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.header"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.header">Header</a>
 270         </h6>
 271 <p>
 272           <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">spherical</span><span class="special">/</span><span class="identifier">area</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 273         </p>
 274 <h6>
 275 <a name="geometry.reference.strategies.strategy_area_spherical.h6"></a>
 276           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_spherical.see_also"></a></span><a class="link" href="strategy_area_spherical.html#geometry.reference.strategies.strategy_area_spherical.see_also">See
 277           also</a>
 278         </h6>
 279 <p>
 280           <a class="link" href="../algorithms/area/area_2_with_strategy.html" title="area (with strategy)">area
 281           (with strategy)</a>
 282         </p>
 283 </div>
 284 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 285 <td align="left"></td>
 286 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 287       Wulkiewicz, Oracle and/or its affiliates<p>
 288         Distributed under the Boost Software License, Version 1.0. (See accompanying
 289         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>)
 290       </p>
 291 </div></td>
 292 </tr></table>
 293 <hr>
 294 <div class="spirit-nav">
 295 <a accesskey="p" href="strategy_area_cartesian.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_geographic.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 296 </div>
 297 </body>
 298 </html>