libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box.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="namespaceboost_1_1geometry_1_1strategy_1_1distance_1_1comparable.html">comparable</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box.html">pythagoras_box_box</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_1comparable_1_1pythagoras__box__box-members.html">List of all members</a>  </div>
  54   <div class="headertitle">
  55 <div class="title">boost::geometry::strategy::distance::comparable::pythagoras_box_box&lt; CalculationType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__strategies.html">strategies: strategies</a></div></div>  </div>
  56 </div><!--header-->
  57 <div class="contents">
  58
  59 <p>Strategy to calculate comparable distance between two boxes.
  60  <a href="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box.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_1comparable_1_1pythagoras__box__box_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:ad3d1b11db59e71706eece6aa04a6cd26"><td class="memTemplParams" colspan="2">template&lt;typename Box1 , typename Box2 &gt; </td></tr>
  70 <tr class="memitem:ad3d1b11db59e71706eece6aa04a6cd26"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="structboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box_1_1calculation__type.html">calculation_type</a>&lt; Box1, <br class="typebreak"/>
  71 Box2 &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box.html#ad3d1b11db59e71706eece6aa04a6cd26">apply</a> (Box1 const &amp;box1, Box2 const &amp;box2)</td></tr>
  72 <tr class="separator:ad3d1b11db59e71706eece6aa04a6cd26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table>
  74 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75 <div class="textblock"><h3>template&lt;typename CalculationType = void&gt;<br/>
  76 class boost::geometry::strategy::distance::comparable::pythagoras_box_box&lt; CalculationType &gt;</h3>
  77
  78 <p>Strategy to calculate comparable distance between two boxes. </p>
  79 <dl class="tparams"><dt>Template Parameters</dt><dd>
  80   <table class="tparams">
  81     <tr><td class="paramname">Box1</td><td>first box type </td></tr>
  82     <tr><td class="paramname">Box2</td><td>second box type </td></tr>
  83     <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>
  84   </table>
  85   </dd>
  86 </dl>
  87 </div><h2 class="groupheader">Member Function Documentation</h2>
  88 <a class="anchor" id="ad3d1b11db59e71706eece6aa04a6cd26"></a>
  89 <div class="memitem">
  90 <div class="memproto">
  91 <div class="memtemplate">
  92 template&lt;typename CalculationType  = void&gt; </div>
  93 <div class="memtemplate">
  94 template&lt;typename Box1 , typename Box2 &gt; </div>
  95 <table class="mlabels">
  96   <tr>
  97   <td class="mlabels-left">
  98       <table class="memname">
  99         <tr>
 100           <td class="memname">static <a class="el" href="structboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box_1_1calculation__type.html">calculation_type</a>&lt;Box1, Box2&gt;::type <a class="el" href="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras__box__box.html">boost::geometry::strategy::distance::comparable::pythagoras_box_box</a>&lt; CalculationType &gt;::apply </td>
 101           <td>(</td>
 102           <td class="paramtype">Box1 const &amp;&#160;</td>
 103           <td class="paramname"><em>box1</em>, </td>
 104         </tr>
 105         <tr>
 106           <td class="paramkey"></td>
 107           <td></td>
 108           <td class="paramtype">Box2 const &amp;&#160;</td>
 109           <td class="paramname"><em>box2</em>&#160;</td>
 110         </tr>
 111         <tr>
 112           <td></td>
 113           <td>)</td>
 114           <td></td><td></td>
 115         </tr>
 116       </table>
 117   </td>
 118   <td class="mlabels-right">
 119 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 120   </tr>
 121 </table>
 122 </div><div class="memdoc">
 123
 124 </div>
 125 </div>
 126 </div><!-- contents -->
 127 <hr size="1">
 128 <table width="100%">
 129 <tbody>
 130 <tr>
 131 <td align="left"><small>
 132 <p>April 2, 2011</p>
 133 </small></td>
 134 <td align="right">
 135 <small>
 136 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 137 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 138 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 139 </small>
 140 </td>
 141 </tr>
 142 </tbody>
 143 </table>
 144 <address style="text-align: right;"><small>
 145 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 146 </small></address>
 147 </body>
 148 </html>