• 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_1distance_1_1cross__track.xml]
16[section:strategy_distance_cross_track strategy::distance::cross_track]
17
18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>cross_track</primary></indexterm>'''
19Strategy functor for distance point to segment calculation.
20
21[heading Description]
22Class which calculates the distance of a point to a segment, for points on a sphere or globe
23
24[heading Synopsis]
25``template<typename CalculationType, typename Strategy>
26class strategy::distance::cross_track
27{
28  // ...
29};
30``
31
32[heading Template parameter(s)]
33[table
34[[Parameter] [Default] [Description]]
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[[typename Strategy] [haversine<double, CalculationType>] [underlying point-point distance strategy, defaults to haversine]]
37]
38
39[heading Constructor(s)]
40[table
41[[Function] [Description] [Parameters] ]
42[[``cross_track()``
43
44] [] [
45
46]]
47[[``cross_track(typename Strategy::radius_type const & r)``
48
49] [] [[* typename Strategy::radius_type const &]: ['r]:
50
51
52
53]]
54[[``cross_track(Strategy const & s)``
55
56] [] [[* Strategy const &]: ['s]:
57
58
59
60]]
61]
62
63[heading Member Function(s)]
64[table
65[[Function] [Description] [Parameters]  [Returns]]
66[[``relate_segment_segment_strategy_type get_relate_segment_segment_strategy()``
67
68] [] [
69
70][
71
72]
73]
74[[``point_in_geometry_strategy_type get_point_in_geometry_strategy()``
75
76] [] [
77
78][
79
80]
81]
82[[``template<typename Point, typename PointOfSegment>
83return_type< Point, PointOfSegment >::type apply(Point const & p, PointOfSegment const & sp1, PointOfSegment const & sp2)``
84
85] [] [[* Point const &]: ['p]:
86
87[* PointOfSegment const &]: ['sp1]:
88
89[* PointOfSegment const &]: ['sp2]:
90
91
92
93][
94
95]
96]
97[[``template<typename T1, typename T2>
98radius_type vertical_or_meridian(T1 lat1, T2 lat2)``
99
100] [] [[* T1]: ['lat1]:
101
102[* T2]: ['lat2]:
103
104
105
106][
107
108]
109]
110[[``Strategy::radius_type radius()``
111
112] [] [
113
114][
115
116]
117]
118]
119
120[heading Header]
121`#include <boost/geometry/strategies/spherical/distance_cross_track.hpp>`
122
123[heading See also]
124[link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)]
125
126[endsect]
127
128