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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::area::cartesian</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="../strategies.html" title="Strategies">
  10 <link rel="next" href="strategy_area_spherical.html" title="strategy::area::spherical">
  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="../strategies.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_spherical.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_cartesian"></a><a class="link" href="strategy_area_cartesian.html" title="strategy::area::cartesian">strategy::area::cartesian</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186975597440"></a><a class="indexterm" name="idm46186975596752"></a><a class="indexterm" name="idm46186975596064"></a>
  31 Cartesian area calculation.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_area_cartesian.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.description"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.description">Description</a>
  36         </h6>
  37 <p>
  38           Calculates cartesian area using the trapezoidal rule
  39         </p>
  40 <h6>
  41 <a name="geometry.reference.strategies.strategy_area_cartesian.h1"></a>
  42           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.synopsis"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.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">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">cartesian</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_cartesian.h2"></a>
  56           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.template_parameter_s_"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.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><tr>
  83 <td>
  84                   <p>
  85                     typename CalculationType
  86                   </p>
  87                 </td>
  88 <td>
  89                   <p>
  90                     void
  91                   </p>
  92                 </td>
  93 <td>
  94                   <p>
  95                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
  96                     from the coordinate type and (if necessary) promoted to floating
  97                     point
  98                   </p>
  99                 </td>
 100 </tr></tbody>
 101 </table></div>
 102 <h6>
 103 <a name="geometry.reference.strategies.strategy_area_cartesian.h3"></a>
 104           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.member_function_s_"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.member_function_s_">Member
 105           Function(s)</a>
 106         </h6>
 107 <div class="informaltable"><table class="table">
 108 <colgroup>
 109 <col>
 110 <col>
 111 <col>
 112 <col>
 113 </colgroup>
 114 <thead><tr>
 115 <th>
 116                   <p>
 117                     Function
 118                   </p>
 119                 </th>
 120 <th>
 121                   <p>
 122                     Description
 123                   </p>
 124                 </th>
 125 <th>
 126                   <p>
 127                     Parameters
 128                   </p>
 129                 </th>
 130 <th>
 131                   <p>
 132                     Returns
 133                   </p>
 134                 </th>
 135 </tr></thead>
 136 <tbody>
 137 <tr>
 138 <td>
 139                   <p>
 140 </p>
 141 <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>
 142 <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>
 143 <p>
 144                   </p>
 145                 </td>
 146 <td>
 147                 </td>
 148 <td>
 149                   <p>
 150                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 151                     <span class="emphasis"><em>p1</em></span>:
 152                   </p>
 153                   <p>
 154                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 155                     <span class="emphasis"><em>p2</em></span>:
 156                   </p>
 157                   <p>
 158                     <span class="bold"><strong>state&lt; Geometry &gt; &amp;</strong></span>:
 159                     <span class="emphasis"><em>st</em></span>:
 160                   </p>
 161                 </td>
 162 <td>
 163                 </td>
 164 </tr>
 165 <tr>
 166 <td>
 167                   <p>
 168 </p>
 169 <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>
 170 <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="special">&amp;</span> <span class="identifier">st</span><span class="special">)</span></pre>
 171 <p>
 172                   </p>
 173                 </td>
 174 <td>
 175                 </td>
 176 <td>
 177                   <p>
 178                     <span class="bold"><strong>state&lt; Geometry &gt; &amp;</strong></span>:
 179                     <span class="emphasis"><em>st</em></span>:
 180                   </p>
 181                 </td>
 182 <td>
 183                 </td>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 <h6>
 188 <a name="geometry.reference.strategies.strategy_area_cartesian.h4"></a>
 189           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.header"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.header">Header</a>
 190         </h6>
 191 <p>
 192           <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</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 193         </p>
 194 <h6>
 195 <a name="geometry.reference.strategies.strategy_area_cartesian.h5"></a>
 196           <span class="phrase"><a name="geometry.reference.strategies.strategy_area_cartesian.see_also"></a></span><a class="link" href="strategy_area_cartesian.html#geometry.reference.strategies.strategy_area_cartesian.see_also">See
 197           also</a>
 198         </h6>
 199 <p>
 200           <a class="link" href="../algorithms/area/area_2_with_strategy.html" title="area (with strategy)">area
 201           (with strategy)</a>
 202         </p>
 203 </div>
 204 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 205 <td align="left"></td>
 206 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 207       Wulkiewicz, Oracle and/or its affiliates<p>
 208         Distributed under the Boost Software License, Version 1.0. (See accompanying
 209         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>)
 210       </p>
 211 </div></td>
 212 </tr></table>
 213 <hr>
 214 <div class="spirit-nav">
 215 <a accesskey="p" href="../strategies.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_spherical.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 216 </div>
 217 </body>
 218 </html>