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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::within::franklin</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_within_winding.html" title="strategy::within::winding">
  10 <link rel="next" href="strategy_within_crossings_multiply.html" title="strategy::within::crossings_multiply">
  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_within_winding.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_within_crossings_multiply.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_within_franklin"></a><a class="link" href="strategy_within_franklin.html" title="strategy::within::franklin">strategy::within::franklin</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp136408736"></a><a class="indexterm" name="idp136409424"></a><a class="indexterm" name="idp136410112"></a>
  31 Within detection using cross counting.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_within_franklin.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_franklin.synopsis"></a></span><a class="link" href="strategy_within_franklin.html#geometry.reference.strategies.strategy_within_franklin.synopsis">Synopsis</a>
  36         </h6>
  37 <p>
  38 </p>
  39 <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>
  40 <span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">within</span><span class="special">::</span><span class="identifier">franklin</span>
  41 <span class="special">{</span>
  42   <span class="comment">// ...</span>
  43 <span class="special">};</span>
  44 </pre>
  45 <p>
  46         </p>
  47 <h6>
  48 <a name="geometry.reference.strategies.strategy_within_franklin.h1"></a>
  49           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_franklin.template_parameter_s_"></a></span><a class="link" href="strategy_within_franklin.html#geometry.reference.strategies.strategy_within_franklin.template_parameter_s_">Template
  50           parameter(s)</a>
  51         </h6>
  52 <div class="informaltable"><table class="table">
  53 <colgroup>
  54 <col>
  55 <col>
  56 <col>
  57 </colgroup>
  58 <thead><tr>
  59 <th>
  60                   <p>
  61                     Parameter
  62                   </p>
  63                 </th>
  64 <th>
  65                   <p>
  66                     Default
  67                   </p>
  68                 </th>
  69 <th>
  70                   <p>
  71                     Description
  72                   </p>
  73                 </th>
  74 </tr></thead>
  75 <tbody>
  76 <tr>
  77 <td>
  78                   <p>
  79                     typename Point
  80                   </p>
  81                 </td>
  82 <td>
  83                 </td>
  84 <td>
  85                   <p>
  86                     Any type fulfilling a Point Concept
  87                   </p>
  88                 </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                   <p>
  93                     typename PointOfSegment
  94                   </p>
  95                 </td>
  96 <td>
  97                   <p>
  98                     Point
  99                   </p>
 100                 </td>
 101 <td>
 102                   <p>
 103                     segment point type
 104                   </p>
 105                 </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                   <p>
 110                     typename CalculationType
 111                   </p>
 112                 </td>
 113 <td>
 114                   <p>
 115                     void
 116                   </p>
 117                 </td>
 118 <td>
 119                   <p>
 120                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
 121                     from the coordinate type and (if necessary) promoted to floating
 122                     point
 123                   </p>
 124                 </td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 <h6>
 129 <a name="geometry.reference.strategies.strategy_within_franklin.h2"></a>
 130           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_franklin.member_function_s_"></a></span><a class="link" href="strategy_within_franklin.html#geometry.reference.strategies.strategy_within_franklin.member_function_s_">Member
 131           Function(s)</a>
 132         </h6>
 133 <div class="informaltable"><table class="table">
 134 <colgroup>
 135 <col>
 136 <col>
 137 <col>
 138 <col>
 139 </colgroup>
 140 <thead><tr>
 141 <th>
 142                   <p>
 143                     Function
 144                   </p>
 145                 </th>
 146 <th>
 147                   <p>
 148                     Description
 149                   </p>
 150                 </th>
 151 <th>
 152                   <p>
 153                     Parameters
 154                   </p>
 155                 </th>
 156 <th>
 157                   <p>
 158                     Returns
 159                   </p>
 160                 </th>
 161 </tr></thead>
 162 <tbody>
 163 <tr>
 164 <td>
 165                   <p>
 166 </p>
 167 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">apply</span><span class="special">(</span><span class="identifier">Point</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">point</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">seg1</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">seg2</span><span class="special">,</span>
 168            <span class="identifier">crossings</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
 169 <p>
 170                   </p>
 171                 </td>
 172 <td>
 173                 </td>
 174 <td>
 175                   <p>
 176                     <span class="bold"><strong>Point const &amp;</strong></span>: <span class="emphasis"><em>point</em></span>:
 177                   </p>
 178                   <p>
 179                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 180                     <span class="emphasis"><em>seg1</em></span>:
 181                   </p>
 182                   <p>
 183                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 184                     <span class="emphasis"><em>seg2</em></span>:
 185                   </p>
 186                   <p>
 187                     <span class="bold"><strong>crossings &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 188                   </p>
 189                 </td>
 190 <td>
 191                 </td>
 192 </tr>
 193 <tr>
 194 <td>
 195                   <p>
 196 </p>
 197 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">int</span> <span class="identifier">result</span><span class="special">(</span><span class="identifier">crossings</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
 198 <p>
 199                   </p>
 200                 </td>
 201 <td>
 202                 </td>
 203 <td>
 204                   <p>
 205                     <span class="bold"><strong>crossings const &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
 206                   </p>
 207                 </td>
 208 <td>
 209                 </td>
 210 </tr>
 211 </tbody>
 212 </table></div>
 213 <h6>
 214 <a name="geometry.reference.strategies.strategy_within_franklin.h3"></a>
 215           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_franklin.header"></a></span><a class="link" href="strategy_within_franklin.html#geometry.reference.strategies.strategy_within_franklin.header">Header</a>
 216         </h6>
 217 <p>
 218           <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">point_in_poly_franklin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 219         </p>
 220 <h6>
 221 <a name="geometry.reference.strategies.strategy_within_franklin.h4"></a>
 222           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_franklin.see_also"></a></span><a class="link" href="strategy_within_franklin.html#geometry.reference.strategies.strategy_within_franklin.see_also">See
 223           also</a>
 224         </h6>
 225 <p>
 226           <a class="link" href="../algorithms/within/within_3_with_strategy.html" title="within (with strategy)">within
 227           (with strategy)</a>
 228         </p>
 229 </div>
 230 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 231 <td align="left"></td>
 232 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 233       Wulkiewicz, Oracle and/or its affiliates<p>
 234         Distributed under the Boost Software License, Version 1.0. (See accompanying
 235         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>)
 236       </p>
 237 </div></td>
 238 </tr></table>
 239 <hr>
 240 <div class="spirit-nav">
 241 <a accesskey="p" href="strategy_within_winding.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_within_crossings_multiply.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 242 </div>
 243 </body>
 244 </html>