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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::distance::projected_point</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&#160;1.&#160;Geometry">
   8 <link rel="up" href="../strategies.html" title="Strategies">
   9 <link rel="prev" href="strategy_distance_haversine.html" title="strategy::distance::haversine">
  10 <link rel="next" href="strategy_distance_cross_track.html" title="strategy::distance::cross_track">
  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_distance_haversine.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_distance_cross_track.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_distance_projected_point"></a><a class="link" href="strategy_distance_projected_point.html" title="strategy::distance::projected_point">strategy::distance::projected_point</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp120360272"></a><a class="indexterm" name="idp120360960"></a><a class="indexterm" name="idp120361648"></a>
  31 Strategy for distance point to segment.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.strategies.strategy_distance_projected_point.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.description"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.description">Description</a>
  36         </h6>
  37 <p>
  38           Calculates distance using projected-point method, and (optionally) Pythagoras
  39         </p>
  40 <h6>
  41 <a name="geometry.reference.strategies.strategy_distance_projected_point.h1"></a>
  42           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.synopsis"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.synopsis">Synopsis</a>
  43         </h6>
  44 <p>
  45 </p>
  46 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  47 <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">projected_point</span>
  48 <span class="special">{</span>
  49   <span class="comment">// ...</span>
  50 <span class="special">};</span>
  51 </pre>
  52 <p>
  53         </p>
  54 <h6>
  55 <a name="geometry.reference.strategies.strategy_distance_projected_point.h2"></a>
  56           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.template_parameter_s_"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.template_parameter_s_">Template
  57           parameter(s)</a>
  58         </h6>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                   <p>
  68                     Parameter
  69                   </p>
  70                 </th>
  71 <th>
  72                   <p>
  73                     Default
  74                   </p>
  75                 </th>
  76 <th>
  77                   <p>
  78                     Description
  79                   </p>
  80                 </th>
  81 </tr></thead>
  82 <tbody>
  83 <tr>
  84 <td>
  85                   <p>
  86                     typename CalculationType
  87                   </p>
  88                 </td>
  89 <td>
  90                   <p>
  91                     void
  92                   </p>
  93                 </td>
  94 <td>
  95                   <p>
  96                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
  97                     from the coordinate type and (if necessary) promoted to floating
  98                     point
  99                   </p>
 100                 </td>
 101 </tr>
 102 <tr>
 103 <td>
 104                   <p>
 105                     typename Strategy
 106                   </p>
 107                 </td>
 108 <td>
 109                   <p>
 110                     pythagoras&lt;CalculationType&gt;
 111                   </p>
 112                 </td>
 113 <td>
 114                   <p>
 115                     underlying point-point distance strategy
 116                   </p>
 117                 </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 <h6>
 122 <a name="geometry.reference.strategies.strategy_distance_projected_point.h3"></a>
 123           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.member_function_s_"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.member_function_s_">Member
 124           Function(s)</a>
 125         </h6>
 126 <div class="informaltable"><table class="table">
 127 <colgroup>
 128 <col>
 129 <col>
 130 <col>
 131 <col>
 132 </colgroup>
 133 <thead><tr>
 134 <th>
 135                   <p>
 136                     Function
 137                   </p>
 138                 </th>
 139 <th>
 140                   <p>
 141                     Description
 142                   </p>
 143                 </th>
 144 <th>
 145                   <p>
 146                     Parameters
 147                   </p>
 148                 </th>
 149 <th>
 150                   <p>
 151                     Returns
 152                   </p>
 153                 </th>
 154 </tr></thead>
 155 <tbody><tr>
 156 <td>
 157                   <p>
 158 </p>
 159 <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>
 160 <span class="identifier">calculation_type</span><span class="special">&lt;</span> <span class="identifier">Point</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="special">&gt;::</span><span class="identifier">type</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">p</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">PointOfSegment</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p2</span><span class="special">)</span></pre>
 161 <p>
 162                   </p>
 163                 </td>
 164 <td>
 165                 </td>
 166 <td>
 167                   <p>
 168                     <span class="bold"><strong>Point const &amp;</strong></span>: <span class="emphasis"><em>p</em></span>:
 169                   </p>
 170                   <p>
 171                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 172                     <span class="emphasis"><em>p1</em></span>:
 173                   </p>
 174                   <p>
 175                     <span class="bold"><strong>PointOfSegment const &amp;</strong></span>:
 176                     <span class="emphasis"><em>p2</em></span>:
 177                   </p>
 178                 </td>
 179 <td>
 180                 </td>
 181 </tr></tbody>
 182 </table></div>
 183 <h6>
 184 <a name="geometry.reference.strategies.strategy_distance_projected_point.h4"></a>
 185           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.header"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.header">Header</a>
 186         </h6>
 187 <p>
 188           <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">distance_projected_point</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 189         </p>
 190 <h6>
 191 <a name="geometry.reference.strategies.strategy_distance_projected_point.h5"></a>
 192           <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_projected_point.see_also"></a></span><a class="link" href="strategy_distance_projected_point.html#geometry.reference.strategies.strategy_distance_projected_point.see_also">See
 193           also</a>
 194         </h6>
 195 <p>
 196           <a class="link" href="../algorithms/distance/distance_3_with_strategy.html" title="distance (with strategy)">distance
 197           (with strategy)</a>
 198         </p>
 199 </div>
 200 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 201 <td align="left"></td>
 202 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 203       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 204       affiliates<p>
 205         Distributed under the Boost Software License, Version 1.0. (See accompanying
 206         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>)
 207       </p>
 208 </div></td>
 209 </tr></table>
 210 <hr>
 211 <div class="spirit-nav">
 212 <a accesskey="p" href="strategy_distance_haversine.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_distance_cross_track.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 213 </div>
 214 </body>
 215 </html>