• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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.79.1">
7<link rel="home" href="../../../index.html" title="Chapter 1. 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="idm45635667081648"></a><a class="indexterm" name="idm45635667080960"></a><a class="indexterm" name="idm45635667080272"></a>
31Within 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">,</span> <span class="special">,</span>
40         <span class="special">&gt;</span>
41<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>
42<span class="special">{</span>
43  <span class="comment">// ...</span>
44<span class="special">};</span>
45</pre>
46<p>
47        </p>
48<h6>
49<a name="geometry.reference.strategies.strategy_within_franklin.h1"></a>
50          <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
51          parameter(s)</a>
52        </h6>
53<div class="informaltable"><table class="table">
54<colgroup>
55<col>
56<col>
57<col>
58</colgroup>
59<thead><tr>
60<th>
61                  <p>
62                    Parameter
63                  </p>
64                </th>
65<th>
66                  <p>
67                    Default
68                  </p>
69                </th>
70<th>
71                  <p>
72                    Description
73                  </p>
74                </th>
75</tr></thead>
76<tbody>
77<tr>
78<td>
79                  <p>
80                    typename Point_
81                  </p>
82                </td>
83<td>
84                </td>
85<td>
86                </td>
87</tr>
88<tr>
89<td>
90                  <p>
91                    typename PointOfSegment_
92                  </p>
93                </td>
94<td>
95                  <p>
96                    Point_
97                  </p>
98                </td>
99<td>
100                </td>
101</tr>
102<tr>
103<td>
104                  <p>
105                    typename CalculationType
106                  </p>
107                </td>
108<td>
109                  <p>
110                    void
111                  </p>
112                </td>
113<td>
114                  <p>
115                    numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
116                    from the coordinate type and (if necessary) promoted to floating
117                    point
118                  </p>
119                </td>
120</tr>
121<tr>
122<td>
123                </td>
124<td>
125                </td>
126<td>
127                  <p>
128                    Any type fulfilling a Point Concept
129                  </p>
130                </td>
131</tr>
132<tr>
133<td>
134                </td>
135<td>
136                </td>
137<td>
138                  <p>
139                    segment point type
140                  </p>
141                </td>
142</tr>
143</tbody>
144</table></div>
145<h6>
146<a name="geometry.reference.strategies.strategy_within_franklin.h2"></a>
147          <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
148          Function(s)</a>
149        </h6>
150<div class="informaltable"><table class="table">
151<colgroup>
152<col>
153<col>
154<col>
155<col>
156</colgroup>
157<thead><tr>
158<th>
159                  <p>
160                    Function
161                  </p>
162                </th>
163<th>
164                  <p>
165                    Description
166                  </p>
167                </th>
168<th>
169                  <p>
170                    Parameters
171                  </p>
172                </th>
173<th>
174                  <p>
175                    Returns
176                  </p>
177                </th>
178</tr></thead>
179<tbody>
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="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">&gt;</span>
185<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>
186           <span class="identifier">crossings</span> <span class="special">&amp;</span> <span class="identifier">state</span><span class="special">)</span></pre>
187<p>
188                  </p>
189                </td>
190<td>
191                </td>
192<td>
193                  <p>
194                    <span class="bold"><strong>Point const &amp;</strong></span>: <span class="emphasis"><em>point</em></span>:
195                  </p>
196                  <p>
197                    <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
198                    <span class="emphasis"><em>seg1</em></span>:
199                  </p>
200                  <p>
201                    <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
202                    <span class="emphasis"><em>seg2</em></span>:
203                  </p>
204                  <p>
205                    <span class="bold"><strong>crossings &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
206                  </p>
207                </td>
208<td>
209                </td>
210</tr>
211<tr>
212<td>
213                  <p>
214</p>
215<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>
216<p>
217                  </p>
218                </td>
219<td>
220                </td>
221<td>
222                  <p>
223                    <span class="bold"><strong>crossings const &amp;</strong></span>: <span class="emphasis"><em>state</em></span>:
224                  </p>
225                </td>
226<td>
227                </td>
228</tr>
229</tbody>
230</table></div>
231<h6>
232<a name="geometry.reference.strategies.strategy_within_franklin.h3"></a>
233          <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>
234        </h6>
235<p>
236          <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>
237        </p>
238<h6>
239<a name="geometry.reference.strategies.strategy_within_franklin.h4"></a>
240          <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
241          also</a>
242        </h6>
243<p>
244          <a class="link" href="../algorithms/within/within_3_with_strategy.html" title="within (with strategy)">within
245          (with strategy)</a>
246        </p>
247</div>
248<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
249<td align="left"></td>
250<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
251      Wulkiewicz, Oracle and/or its affiliates<p>
252        Distributed under the Boost Software License, Version 1.0. (See accompanying
253        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>)
254      </p>
255</div></td>
256</tr></table>
257<hr>
258<div class="spirit-nav">
259<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>
260</div>
261</body>
262</html>
263