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

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