• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1franklin.xml]
16[section:strategy_within_franklin strategy::within::franklin]
17
18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>within</primary></indexterm><indexterm><primary>franklin</primary></indexterm>'''
19Within detection using cross counting.
20
21[heading Synopsis]
22``template<typename Point_, typename PointOfSegment_, typename CalculationType, ,
23         >
24class strategy::within::franklin
25{
26  // ...
27};
28``
29
30[heading Template parameter(s)]
31[table
32[[Parameter] [Default] [Description]]
33[[typename Point_] [] []]
34[[typename PointOfSegment_] [Point_] []]
35[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
36[[] [] [Any type fulfilling a Point Concept ]]
37[[] [] [segment point type ]]
38]
39
40[heading Member Function(s)]
41[table
42[[Function] [Description] [Parameters]  [Returns]]
43[[``template<typename Point, typename PointOfSegment>
44bool apply(Point const & point, PointOfSegment const & seg1, PointOfSegment const & seg2,
45           crossings & state)``
46
47] [] [[* Point const &]: ['point]:
48
49[* PointOfSegment const &]: ['seg1]:
50
51[* PointOfSegment const &]: ['seg2]:
52
53[* crossings &]: ['state]:
54
55
56
57][
58
59]
60]
61[[``int result(crossings const & state)``
62
63] [] [[* crossings const &]: ['state]:
64
65
66
67][
68
69]
70]
71]
72
73[heading Header]
74`#include <boost/geometry/strategies/cartesian/point_in_poly_franklin.hpp>`
75
76[heading See also]
77[link geometry.reference.algorithms.within.within_3_with_strategy within (with strategy)]
78
79[endsect]
80
81