libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36   <div id="navrow2" class="tabs2">
  37     <ul class="tablist">
  38       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  40       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  41       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42     </ul>
  43   </div>
  44 <div id="nav-path" class="navpath">
  45   <ul>
  46 <li class="navelem"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry_1_1strategy.html">strategy</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry_1_1strategy_1_1distance.html">distance</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.html">pythagoras</a></li>  </ul>
  47 </div>
  48 </div><!-- top -->
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#nested-classes">Classes</a> &#124;
  52 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  53 <a href="classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras-members.html">List of all members</a>  </div>
  54   <div class="headertitle">
  55 <div class="title">boost::geometry::strategy::distance::pythagoras&lt; CalculationType &gt; Class Template Reference</div>  </div>
  56 </div><!--header-->
  57 <div class="contents">
  58
  59 <p>Strategy to calculate the distance between two points.
  60  <a href="classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.html#details">More...</a></p>
  61 <table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  63 Classes</h2></td></tr>
  64 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras_1_1calculation__type.html">calculation_type</a></td></tr>
  65 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table><table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  68 Static Public Member Functions</h2></td></tr>
  69 <tr class="memitem:aee07e7baac11796b2475e0e8e92dd02d"><td class="memTemplParams" colspan="2">template&lt;typename P1 , typename P2 &gt; </td></tr>
  70 <tr class="memitem:aee07e7baac11796b2475e0e8e92dd02d"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="structboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras_1_1calculation__type.html">calculation_type</a>&lt; P1, <br class="typebreak"/>
  71 P2 &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.html#aee07e7baac11796b2475e0e8e92dd02d">apply</a> (P1 const &amp;p1, P2 const &amp;p2)</td></tr>
  72 <tr class="memdesc:aee07e7baac11796b2475e0e8e92dd02d"><td class="mdescLeft">&#160;</td><td class="mdescRight">applies the distance calculation using pythagoras  <a href="#aee07e7baac11796b2475e0e8e92dd02d">More...</a><br/></td></tr>
  73 <tr class="separator:aee07e7baac11796b2475e0e8e92dd02d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 </table>
  75 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  76 <div class="textblock"><h3>template&lt;typename CalculationType = void&gt;<br/>
  77 class boost::geometry::strategy::distance::pythagoras&lt; CalculationType &gt;</h3>
  78
  79 <p>Strategy to calculate the distance between two points. </p>
  80 <dl class="tparams"><dt>Template Parameters</dt><dd>
  81   <table class="tparams">
  82     <tr><td class="paramname">CalculationType</td><td>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</td></tr>
  83   </table>
  84   </dd>
  85 </dl>
  86  </div><h2 class="groupheader">Member Function Documentation</h2>
  87 <a class="anchor" id="aee07e7baac11796b2475e0e8e92dd02d"></a>
  88 <div class="memitem">
  89 <div class="memproto">
  90 <div class="memtemplate">
  91 template&lt;typename CalculationType  = void&gt; </div>
  92 <div class="memtemplate">
  93 template&lt;typename P1 , typename P2 &gt; </div>
  94 <table class="mlabels">
  95   <tr>
  96   <td class="mlabels-left">
  97       <table class="memname">
  98         <tr>
  99           <td class="memname">static <a class="el" href="structboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras_1_1calculation__type.html">calculation_type</a>&lt;P1, P2&gt;::type <a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.html">boost::geometry::strategy::distance::pythagoras</a>&lt; CalculationType &gt;::apply </td>
 100           <td>(</td>
 101           <td class="paramtype">P1 const &amp;&#160;</td>
 102           <td class="paramname"><em>p1</em>, </td>
 103         </tr>
 104         <tr>
 105           <td class="paramkey"></td>
 106           <td></td>
 107           <td class="paramtype">P2 const &amp;&#160;</td>
 108           <td class="paramname"><em>p2</em>&#160;</td>
 109         </tr>
 110         <tr>
 111           <td></td>
 112           <td>)</td>
 113           <td></td><td></td>
 114         </tr>
 115       </table>
 116   </td>
 117   <td class="mlabels-right">
 118 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 119   </tr>
 120 </table>
 121 </div><div class="memdoc">
 122
 123 <p>applies the distance calculation using pythagoras </p>
 124 <dl class="section return"><dt>Returns</dt><dd>the calculated distance (including taking the square root) </dd></dl>
 125 <dl class="params"><dt>Parameters</dt><dd>
 126   <table class="params">
 127     <tr><td class="paramname">p1</td><td>first point </td></tr>
 128     <tr><td class="paramname">p2</td><td>second point </td></tr>
 129   </table>
 130   </dd>
 131 </dl>
 132
 133 </div>
 134 </div>
 135 </div><!-- contents -->
 136 <hr size="1">
 137 <table width="100%">
 138 <tbody>
 139 <tr>
 140 <td align="left"><small>
 141 <p>April 2, 2011</p>
 142 </small></td>
 143 <td align="right">
 144 <small>
 145 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 146 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 147 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 148 </small>
 149 </td>
 150 </tr>
 151 </tbody>
 152 </table>
 153 <address style="text-align: right;"><small>
 154 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 155 </small></address>
 156 </body>
 157 </html>