libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.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_1centroid.html">centroid</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">average</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-types">Public Types</a> &#124;
  53 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  54 <a href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average-members.html">List of all members</a>  </div>
  55   <div class="headertitle">
  56 <div class="title">boost::geometry::strategy::centroid::average&lt; PointCentroid, Point &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__strategies.html">strategies: strategies</a></div></div>  </div>
  57 </div><!--header-->
  58 <div class="contents">
  59
  60 <p>Centroid calculation taking average of points.
  61  <a href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#details">More...</a></p>
  62 <table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64 Public Types</h2></td></tr>
  65 <tr class="memitem:a60b35abbf7882345dfc2edb2bb9e3026"><td class="memItemLeft" align="right" valign="top">typedef PointCentroid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#a60b35abbf7882345dfc2edb2bb9e3026">centroid_point_type</a></td></tr>
  66 <tr class="separator:a60b35abbf7882345dfc2edb2bb9e3026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:ac0f36137983c57820815b3abaf042ea9"><td class="memItemLeft" align="right" valign="top">typedef Point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#ac0f36137983c57820815b3abaf042ea9">point_type</a></td></tr>
  68 <tr class="separator:ac0f36137983c57820815b3abaf042ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:ac143d6508f627077f1adfd7de2c7a500"><td class="memItemLeft" align="right" valign="top">typedef sum&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#ac143d6508f627077f1adfd7de2c7a500">state_type</a></td></tr>
  70 <tr class="separator:ac143d6508f627077f1adfd7de2c7a500"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table><table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  73 Static Public Member Functions</h2></td></tr>
  74 <tr class="memitem:ae9834e97a7b54299dddcde4d93d91656"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#ae9834e97a7b54299dddcde4d93d91656">apply</a> (Point const &amp;p, sum &amp;state)</td></tr>
  75 <tr class="separator:ae9834e97a7b54299dddcde4d93d91656"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:a96417ccd4ad5999c00606e4d93f69ea1"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#a96417ccd4ad5999c00606e4d93f69ea1">result</a> (sum const &amp;state, PointCentroid &amp;<a class="el" href="group__centroid.html#ga3ec2c5e245c42ffaf28f1c88ea564c8c">centroid</a>)</td></tr>
  77 <tr class="separator:a96417ccd4ad5999c00606e4d93f69ea1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table>
  79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80 <div class="textblock"><h3>template&lt;typename PointCentroid, typename Point = PointCentroid&gt;<br/>
  81 class boost::geometry::strategy::centroid::average&lt; PointCentroid, Point &gt;</h3>
  82
  83 <p>Centroid calculation taking average of points. </p>
  84 </div><h2 class="groupheader">Member Typedef Documentation</h2>
  85 <a class="anchor" id="ac143d6508f627077f1adfd7de2c7a500"></a>
  86 <div class="memitem">
  87 <div class="memproto">
  88 <div class="memtemplate">
  89 template&lt;typename PointCentroid , typename Point  = PointCentroid&gt; </div>
  90       <table class="memname">
  91         <tr>
  92           <td class="memname">typedef sum <a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">boost::geometry::strategy::centroid::average</a>&lt; PointCentroid, Point &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#ac143d6508f627077f1adfd7de2c7a500">state_type</a></td>
  93         </tr>
  94       </table>
  95 </div><div class="memdoc">
  96
  97 </div>
  98 </div>
  99 <a class="anchor" id="a60b35abbf7882345dfc2edb2bb9e3026"></a>
 100 <div class="memitem">
 101 <div class="memproto">
 102 <div class="memtemplate">
 103 template&lt;typename PointCentroid , typename Point  = PointCentroid&gt; </div>
 104       <table class="memname">
 105         <tr>
 106           <td class="memname">typedef PointCentroid <a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">boost::geometry::strategy::centroid::average</a>&lt; PointCentroid, Point &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#a60b35abbf7882345dfc2edb2bb9e3026">centroid_point_type</a></td>
 107         </tr>
 108       </table>
 109 </div><div class="memdoc">
 110
 111 </div>
 112 </div>
 113 <a class="anchor" id="ac0f36137983c57820815b3abaf042ea9"></a>
 114 <div class="memitem">
 115 <div class="memproto">
 116 <div class="memtemplate">
 117 template&lt;typename PointCentroid , typename Point  = PointCentroid&gt; </div>
 118       <table class="memname">
 119         <tr>
 120           <td class="memname">typedef Point <a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">boost::geometry::strategy::centroid::average</a>&lt; PointCentroid, Point &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html#ac0f36137983c57820815b3abaf042ea9">point_type</a></td>
 121         </tr>
 122       </table>
 123 </div><div class="memdoc">
 124
 125 </div>
 126 </div>
 127 <h2 class="groupheader">Member Function Documentation</h2>
 128 <a class="anchor" id="ae9834e97a7b54299dddcde4d93d91656"></a>
 129 <div class="memitem">
 130 <div class="memproto">
 131 <div class="memtemplate">
 132 template&lt;typename PointCentroid , typename Point  = PointCentroid&gt; </div>
 133 <table class="mlabels">
 134   <tr>
 135   <td class="mlabels-left">
 136       <table class="memname">
 137         <tr>
 138           <td class="memname">static void <a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">boost::geometry::strategy::centroid::average</a>&lt; PointCentroid, Point &gt;::apply </td>
 139           <td>(</td>
 140           <td class="paramtype">Point const &amp;&#160;</td>
 141           <td class="paramname"><em>p</em>, </td>
 142         </tr>
 143         <tr>
 144           <td class="paramkey"></td>
 145           <td></td>
 146           <td class="paramtype">sum &amp;&#160;</td>
 147           <td class="paramname"><em>state</em>&#160;</td>
 148         </tr>
 149         <tr>
 150           <td></td>
 151           <td>)</td>
 152           <td></td><td></td>
 153         </tr>
 154       </table>
 155   </td>
 156   <td class="mlabels-right">
 157 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 158   </tr>
 159 </table>
 160 </div><div class="memdoc">
 161
 162 </div>
 163 </div>
 164 <a class="anchor" id="a96417ccd4ad5999c00606e4d93f69ea1"></a>
 165 <div class="memitem">
 166 <div class="memproto">
 167 <div class="memtemplate">
 168 template&lt;typename PointCentroid , typename Point  = PointCentroid&gt; </div>
 169 <table class="mlabels">
 170   <tr>
 171   <td class="mlabels-left">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">static bool <a class="el" href="classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.html">boost::geometry::strategy::centroid::average</a>&lt; PointCentroid, Point &gt;::result </td>
 175           <td>(</td>
 176           <td class="paramtype">sum const &amp;&#160;</td>
 177           <td class="paramname"><em>state</em>, </td>
 178         </tr>
 179         <tr>
 180           <td class="paramkey"></td>
 181           <td></td>
 182           <td class="paramtype">PointCentroid &amp;&#160;</td>
 183           <td class="paramname"><em>centroid</em>&#160;</td>
 184         </tr>
 185         <tr>
 186           <td></td>
 187           <td>)</td>
 188           <td></td><td></td>
 189         </tr>
 190       </table>
 191   </td>
 192   <td class="mlabels-right">
 193 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 194   </tr>
 195 </table>
 196 </div><div class="memdoc">
 197
 198 </div>
 199 </div>
 200 </div><!-- contents -->
 201 <hr size="1">
 202 <table width="100%">
 203 <tbody>
 204 <tr>
 205 <td align="left"><small>
 206 <p>April 2, 2011</p>
 207 </small></td>
 208 <td align="right">
 209 <small>
 210 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 211 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 212 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 213 </small>
 214 </td>
 215 </tr>
 216 </tbody>
 217 </table>
 218 <address style="text-align: right;"><small>
 219 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 220 </small></address>
 221 </body>
 222 </html>