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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::centroid::bashein_detmer</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_centroid_average.html" title="strategy::centroid::average">
  10 <link rel="next" href="strategy_convex_hull_graham_andrew.html" title="strategy::convex_hull::graham_andrew">
  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_centroid_average.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_convex_hull_graham_andrew.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_centroid_bashein_detmer"></a><a class="link" href="strategy_centroid_bashein_detmer.html" title="strategy::centroid::bashein_detmer">strategy::centroid::bashein_detmer</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186973540336"></a><a class="indexterm" name="idm46186973539648"></a><a class="indexterm" name="idm46186973538960"></a>
  31 Centroid calculation using algorithm Bashein / Detmer.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.description"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.description">Description</a>
  36         </h6>
  37 <p>
  38           Calculates centroid using triangulation method published by Bashein / Detmer
  39         </p>
  40 <h6>
  41 <a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.h1"></a>
  42           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.synopsis"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.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">Point</span><span class="special">,</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>
  47 <span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">centroid</span><span class="special">::</span><span class="identifier">bashein_detmer</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_centroid_bashein_detmer.h2"></a>
  56           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.template_parameter_s_"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.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 Point
  87                   </p>
  88                 </td>
  89 <td>
  90                 </td>
  91 <td>
  92                   <p>
  93                     point type of centroid to calculate
  94                   </p>
  95                 </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                   <p>
 100                     typename PointOfSegment
 101                   </p>
 102                 </td>
 103 <td>
 104                   <p>
 105                     Point
 106                   </p>
 107                 </td>
 108 <td>
 109                   <p>
 110                     point type of segments, defaults to Point
 111                   </p>
 112                 </td>
 113 </tr>
 114 <tr>
 115 <td>
 116                   <p>
 117                     typename CalculationType
 118                   </p>
 119                 </td>
 120 <td>
 121                   <p>
 122                     void
 123                   </p>
 124                 </td>
 125 <td>
 126                   <p>
 127                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
 128                     from the coordinate type and (if necessary) promoted to floating
 129                     point
 130                   </p>
 131                 </td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 <h6>
 136 <a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.h3"></a>
 137           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.member_function_s_"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.member_function_s_">Member
 138           Function(s)</a>
 139         </h6>
 140 <div class="informaltable"><table class="table">
 141 <colgroup>
 142 <col>
 143 <col>
 144 <col>
 145 <col>
 146 </colgroup>
 147 <thead><tr>
 148 <th>
 149                   <p>
 150                     Function
 151                   </p>
 152                 </th>
 153 <th>
 154                   <p>
 155                     Description
 156                   </p>
 157                 </th>
 158 <th>
 159                   <p>
 160                     Parameters
 161                   </p>
 162                 </th>
 163 <th>
 164                   <p>
 165                     Returns
 166                   </p>
 167                 </th>
 168 </tr></thead>
 169 <tbody>
 170 <tr>
 171 <td>
 172                   <p>
 173 </p>
 174 <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">sums</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
 175 <p>
 176                   </p>
 177                 </td>
 178 <td>
 179                 </td>
 180 <td>
 181                   <p>
 182                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 183                     <span class="emphasis"><em>p1</em></span>:
 184                   </p>
 185                   <p>
 186                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 187                     <span class="emphasis"><em>p2</em></span>:
 188                   </p>
 189                   <p>
 190                     <span class="bold"><strong>sums &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 191                   </p>
 192                 </td>
 193 <td>
 194                 </td>
 195 </tr>
 196 <tr>
 197 <td>
 198                   <p>
 199 </p>
 200 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">result</span><span class="special">(</span><span class="identifier">sums</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">,</span> <span class="identifier">Point</span> <span class="special">&amp;</span> <span class="identifier">centroid</span><span class="special">)</span></pre>
 201 <p>
 202                   </p>
 203                 </td>
 204 <td>
 205                 </td>
 206 <td>
 207                   <p>
 208                     <span class="bold"><strong>sums const &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 209                   </p>
 210                   <p>
 211                     <span class="bold"><strong>Point &amp;</strong></span>: <span class="emphasis"><em>centroid</em></span>:
 212                   </p>
 213                 </td>
 214 <td>
 215                 </td>
 216 </tr>
 217 </tbody>
 218 </table></div>
 219 <h6>
 220 <a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.h4"></a>
 221           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.header"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.header">Header</a>
 222         </h6>
 223 <p>
 224           <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">centroid_bashein_detmer</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 225         </p>
 226 <h6>
 227 <a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.h5"></a>
 228           <span class="phrase"><a name="geometry.reference.strategies.strategy_centroid_bashein_detmer.see_also"></a></span><a class="link" href="strategy_centroid_bashein_detmer.html#geometry.reference.strategies.strategy_centroid_bashein_detmer.see_also">See
 229           also</a>
 230         </h6>
 231 <p>
 232           <a class="link" href="../algorithms/centroid/centroid_3_with_strategy.html" title="centroid (with strategy)">centroid
 233           (with strategy)</a>
 234         </p>
 235 </div>
 236 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 237 <td align="left"></td>
 238 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 239       Wulkiewicz, Oracle and/or its affiliates<p>
 240         Distributed under the Boost Software License, Version 1.0. (See accompanying
 241         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>)
 242       </p>
 243 </div></td>
 244 </tr></table>
 245 <hr>
 246 <div class="spirit-nav">
 247 <a accesskey="p" href="strategy_centroid_average.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_convex_hull_graham_andrew.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 248 </div>
 249 </body>
 250 </html>