diff options
Diffstat (limited to 'libs/geometry/doc/html/geometry/reference/strategies/strategy_distance_cross_track.html')
| -rwxr-xr-x | libs/geometry/doc/html/geometry/reference/strategies/strategy_distance_cross_track.html | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/libs/geometry/doc/html/geometry/reference/strategies/strategy_distance_cross_track.html b/libs/geometry/doc/html/geometry/reference/strategies/strategy_distance_cross_track.html new file mode 100755 index 0000000000..6173d43c8f --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/strategies/strategy_distance_cross_track.html @@ -0,0 +1,332 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>strategy::distance::cross_track</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="Chapter 1. Geometry"> +<link rel="up" href="../strategies.html" title="Strategies"> +<link rel="prev" href="strategy_distance_projected_point.html" title="strategy::distance::projected_point"> +<link rel="next" href="strategy_area_surveyor.html" title="strategy::area::surveyor"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="strategy_distance_projected_point.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_area_surveyor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.strategies.strategy_distance_cross_track"></a><a class="link" href="strategy_distance_cross_track.html" title="strategy::distance::cross_track">strategy::distance::cross_track</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id959329"></a><a class="indexterm" name="id959334"></a><a class="indexterm" name="id959340"></a> +Strategy functor for distance point to segment calculation. + </p> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h0"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.description"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.description">Description</a> + </h6> +<p> + Class which calculates the distance of a point to a segment, using latlong + points + </p> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h1"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.synopsis"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.synopsis">Synopsis</a> + </h6> +<p> +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</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="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">distance</span><span class="special">::</span><span class="identifier">cross_track</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h2"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.template_parameter_s_"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Default + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + typename Point + </p> + </td> +<td> + </td> +<td> + <p> + point type + </p> + </td> +</tr> +<tr> +<td> + <p> + typename PointOfSegment + </p> + </td> +<td> + <p> + Point + </p> + </td> +<td> + <p> + segment point type + </p> + </td> +</tr> +<tr> +<td> + <p> + typename CalculationType + </p> + </td> +<td> + <p> + void + </p> + </td> +<td> + <p> + numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically + from the coordinate type and (if necessary) promoted to floating + point + </p> + </td> +</tr> +<tr> +<td> + <p> + typename Strategy + </p> + </td> +<td> + <p> + typename services::default_strategy<point_tag, Point>::type + </p> + </td> +<td> + <p> + underlying point-point distance strategy, defaults to haversine + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h3"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.constructor_s_"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.constructor_s_">Constructor(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">cross_track</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">cross_track</span><span class="special">(</span><span class="identifier">return_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">r</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + <p> + <span class="bold"><strong>return_type const &</strong></span>: <span class="emphasis"><em>r</em></span>: + </p> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">cross_track</span><span class="special">(</span><span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">s</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + <p> + <span class="bold"><strong>Strategy const &</strong></span>: <span class="emphasis"><em>s</em></span>: + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h4"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.member_function_s_"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.member_function_s_">Member + Function(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +<th> + <p> + Returns + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">return_type</span> <span class="identifier">apply</span><span class="special">(</span><span class="identifier">Point</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">sp1</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">sp2</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + <p> + <span class="bold"><strong>Point const &</strong></span>: <span class="emphasis"><em>p</em></span>: + </p> + <p> + <span class="bold"><strong>PointOfSegment const &</strong></span>: + <span class="emphasis"><em>sp1</em></span>: + </p> + <p> + <span class="bold"><strong>PointOfSegment const &</strong></span>: + <span class="emphasis"><em>sp2</em></span>: + </p> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">return_type</span> <span class="identifier">radius</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h5"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.header"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.header">Header</a> + </h6> +<p> + <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</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">spherical</span><span class="special">/</span><span class="identifier">distance_cross_track</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> +<h6> +<a name="geometry.reference.strategies.strategy_distance_cross_track.h6"></a> + <span><a name="geometry.reference.strategies.strategy_distance_cross_track.see_also"></a></span><a class="link" href="strategy_distance_cross_track.html#geometry.reference.strategies.strategy_distance_cross_track.see_also">See + also</a> + </h6> +<p> + <a class="link" href="../algorithms/distance/distance_3_with_strategy.html" title="distance (with strategy)">distance + (with strategy)</a> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Barend + Gehrels, Bruno Lalande, Mateusz Loskot<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="strategy_distance_projected_point.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_area_surveyor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |