libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1side__info.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="classboost_1_1geometry_1_1side__info.html">side_info</a></li>  </ul>
  47 </div>
  48 </div><!-- top -->
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#pub-methods">Public Member Functions</a> &#124;
  52 <a href="#pub-attribs">Public Attributes</a> &#124;
  53 <a href="classboost_1_1geometry_1_1side__info-members.html">List of all members</a>  </div>
  54   <div class="headertitle">
  55 <div class="title">boost::geometry::side_info Class Reference</div>  </div>
  56 </div><!--header-->
  57 <div class="contents">
  58
  59 <p>Class <a class="el" href="classboost_1_1geometry_1_1side__info.html" title="Class side_info: small class wrapping for sides (-1,0,1) ">side_info</a>: small class wrapping for sides (-1,0,1)
  60  <a href="classboost_1_1geometry_1_1side__info.html#details">More...</a></p>
  61 <table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  63 Public Member Functions</h2></td></tr>
  64 <tr class="memitem:af0a794a8ab908b3a38ed230ca49267fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#af0a794a8ab908b3a38ed230ca49267fe">collinear</a> () const </td></tr>
  65 <tr class="separator:af0a794a8ab908b3a38ed230ca49267fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:a8d696e4f72ea4d2b519f775b5ed6b208"><td class="memTemplParams" colspan="2">template&lt;int Which, int Index&gt; </td></tr>
  67 <tr class="memitem:a8d696e4f72ea4d2b519f775b5ed6b208"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a8d696e4f72ea4d2b519f775b5ed6b208">correct_to_zero</a> ()</td></tr>
  68 <tr class="separator:a8d696e4f72ea4d2b519f775b5ed6b208"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:aac64aae77faa84e7e4b0dfe45b37c864"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#aac64aae77faa84e7e4b0dfe45b37c864">crossing</a> () const </td></tr>
  70 <tr class="separator:aac64aae77faa84e7e4b0dfe45b37c864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a8bb209ab35df6b765bf758f78667b009"><td class="memTemplParams" colspan="2">template&lt;int Which, int Index&gt; </td></tr>
  72 <tr class="memitem:a8bb209ab35df6b765bf758f78667b009"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a8bb209ab35df6b765bf758f78667b009">get</a> () const </td></tr>
  73 <tr class="separator:a8bb209ab35df6b765bf758f78667b009"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:a751a28e7b218cb229b3cb76462ebdadc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a751a28e7b218cb229b3cb76462ebdadc">meeting</a> () const </td></tr>
  75 <tr class="separator:a751a28e7b218cb229b3cb76462ebdadc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:a4216e6a8d026549fe9a434ba4b8a948b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a4216e6a8d026549fe9a434ba4b8a948b">one_of_all_zero</a> () const </td></tr>
  77 <tr class="separator:a4216e6a8d026549fe9a434ba4b8a948b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a6343f1e6ac223c409f567eaf04b8d305"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
  79 <tr class="memitem:a6343f1e6ac223c409f567eaf04b8d305"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a6343f1e6ac223c409f567eaf04b8d305">one_touching</a> () const </td></tr>
  80 <tr class="separator:a6343f1e6ac223c409f567eaf04b8d305"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:a40b02d344eb55a2ed0595b18a9a02a85"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
  82 <tr class="memitem:a40b02d344eb55a2ed0595b18a9a02a85"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a40b02d344eb55a2ed0595b18a9a02a85">one_zero</a> () const </td></tr>
  83 <tr class="separator:a40b02d344eb55a2ed0595b18a9a02a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:ac35fc700fabf86acc653a0b91e3de2b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#ac35fc700fabf86acc653a0b91e3de2b8">reverse</a> ()</td></tr>
  85 <tr class="separator:ac35fc700fabf86acc653a0b91e3de2b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:aa45b556d006986d3895eef8fe68d8f29"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
  87 <tr class="memitem:aa45b556d006986d3895eef8fe68d8f29"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#aa45b556d006986d3895eef8fe68d8f29">same</a> () const </td></tr>
  88 <tr class="separator:aa45b556d006986d3895eef8fe68d8f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a71013b833c4bb35997a810957a490c93"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
  90 <tr class="memitem:a71013b833c4bb35997a810957a490c93"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a71013b833c4bb35997a810957a490c93">set</a> (int first, int second)</td></tr>
  91 <tr class="separator:a71013b833c4bb35997a810957a490c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a8bdd284ac2b979894dbef1a673a9f969"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a8bdd284ac2b979894dbef1a673a9f969">side_info</a> (int side_a1=0, int side_a2=0, int side_b1=0, int side_b2=0)</td></tr>
  93 <tr class="separator:a8bdd284ac2b979894dbef1a673a9f969"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a63d69eefab159b0911e322758f259506"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a63d69eefab159b0911e322758f259506">touching</a> () const </td></tr>
  95 <tr class="separator:a63d69eefab159b0911e322758f259506"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a98692676549525179f6adff4fdde7c45"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
  97 <tr class="memitem:a98692676549525179f6adff4fdde7c45"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a98692676549525179f6adff4fdde7c45">zero</a> () const </td></tr>
  98 <tr class="separator:a98692676549525179f6adff4fdde7c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:a091358b204c811933a29d3d2771e9287"><td class="memTemplParams" colspan="2">template&lt;int Which&gt; </td></tr>
 100 <tr class="memitem:a091358b204c811933a29d3d2771e9287"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a091358b204c811933a29d3d2771e9287">zero_index</a> () const </td></tr>
 101 <tr class="separator:a091358b204c811933a29d3d2771e9287"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 </table><table class="memberdecls">
 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 104 Public Attributes</h2></td></tr>
 105 <tr class="memitem:a5d6c4378a28c60b0b4f2f4ede892d95e"><td class="memItemLeft" align="right" valign="top">std::pair&lt; int, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1side__info.html#a5d6c4378a28c60b0b4f2f4ede892d95e">sides</a> [2]</td></tr>
 106 <tr class="separator:a5d6c4378a28c60b0b4f2f4ede892d95e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 </table>
 108 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 109 <div class="textblock"><p>Class <a class="el" href="classboost_1_1geometry_1_1side__info.html" title="Class side_info: small class wrapping for sides (-1,0,1) ">side_info</a>: small class wrapping for sides (-1,0,1) </p>
 110 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 111 <a class="anchor" id="a8bdd284ac2b979894dbef1a673a9f969"></a>
 112 <div class="memitem">
 113 <div class="memproto">
 114       <table class="memname">
 115         <tr>
 116           <td class="memname">boost::geometry::side_info::side_info </td>
 117           <td>(</td>
 118           <td class="paramtype">int&#160;</td>
 119           <td class="paramname"><em>side_a1</em> = <code>0</code>, </td>
 120         </tr>
 121         <tr>
 122           <td class="paramkey"></td>
 123           <td></td>
 124           <td class="paramtype">int&#160;</td>
 125           <td class="paramname"><em>side_a2</em> = <code>0</code>, </td>
 126         </tr>
 127         <tr>
 128           <td class="paramkey"></td>
 129           <td></td>
 130           <td class="paramtype">int&#160;</td>
 131           <td class="paramname"><em>side_b1</em> = <code>0</code>, </td>
 132         </tr>
 133         <tr>
 134           <td class="paramkey"></td>
 135           <td></td>
 136           <td class="paramtype">int&#160;</td>
 137           <td class="paramname"><em>side_b2</em> = <code>0</code>&#160;</td>
 138         </tr>
 139         <tr>
 140           <td></td>
 141           <td>)</td>
 142           <td></td><td></td>
 143         </tr>
 144       </table>
 145 </div><div class="memdoc">
 146
 147 </div>
 148 </div>
 149 <h2 class="groupheader">Member Function Documentation</h2>
 150 <a class="anchor" id="a71013b833c4bb35997a810957a490c93"></a>
 151 <div class="memitem">
 152 <div class="memproto">
 153 <div class="memtemplate">
 154 template&lt;int Which&gt; </div>
 155       <table class="memname">
 156         <tr>
 157           <td class="memname">void boost::geometry::side_info::set </td>
 158           <td>(</td>
 159           <td class="paramtype">int&#160;</td>
 160           <td class="paramname"><em>first</em>, </td>
 161         </tr>
 162         <tr>
 163           <td class="paramkey"></td>
 164           <td></td>
 165           <td class="paramtype">int&#160;</td>
 166           <td class="paramname"><em>second</em>&#160;</td>
 167         </tr>
 168         <tr>
 169           <td></td>
 170           <td>)</td>
 171           <td></td><td></td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 </div>
 177 </div>
 178 <a class="anchor" id="a8d696e4f72ea4d2b519f775b5ed6b208"></a>
 179 <div class="memitem">
 180 <div class="memproto">
 181 <div class="memtemplate">
 182 template&lt;int Which, int Index&gt; </div>
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">void boost::geometry::side_info::correct_to_zero </td>
 186           <td>(</td>
 187           <td class="paramname"></td><td>)</td>
 188           <td></td>
 189         </tr>
 190       </table>
 191 </div><div class="memdoc">
 192
 193 </div>
 194 </div>
 195 <a class="anchor" id="a8bb209ab35df6b765bf758f78667b009"></a>
 196 <div class="memitem">
 197 <div class="memproto">
 198 <div class="memtemplate">
 199 template&lt;int Which, int Index&gt; </div>
 200       <table class="memname">
 201         <tr>
 202           <td class="memname">int boost::geometry::side_info::get </td>
 203           <td>(</td>
 204           <td class="paramname"></td><td>)</td>
 205           <td> const</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 </div>
 211 </div>
 212 <a class="anchor" id="aa45b556d006986d3895eef8fe68d8f29"></a>
 213 <div class="memitem">
 214 <div class="memproto">
 215 <div class="memtemplate">
 216 template&lt;int Which&gt; </div>
 217       <table class="memname">
 218         <tr>
 219           <td class="memname">bool boost::geometry::side_info::same </td>
 220           <td>(</td>
 221           <td class="paramname"></td><td>)</td>
 222           <td> const</td>
 223         </tr>
 224       </table>
 225 </div><div class="memdoc">
 226
 227 </div>
 228 </div>
 229 <a class="anchor" id="af0a794a8ab908b3a38ed230ca49267fe"></a>
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">bool boost::geometry::side_info::collinear </td>
 235           <td>(</td>
 236           <td class="paramname"></td><td>)</td>
 237           <td> const</td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241
 242 </div>
 243 </div>
 244 <a class="anchor" id="aac64aae77faa84e7e4b0dfe45b37c864"></a>
 245 <div class="memitem">
 246 <div class="memproto">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname">bool boost::geometry::side_info::crossing </td>
 250           <td>(</td>
 251           <td class="paramname"></td><td>)</td>
 252           <td> const</td>
 253         </tr>
 254       </table>
 255 </div><div class="memdoc">
 256
 257 </div>
 258 </div>
 259 <a class="anchor" id="a63d69eefab159b0911e322758f259506"></a>
 260 <div class="memitem">
 261 <div class="memproto">
 262       <table class="memname">
 263         <tr>
 264           <td class="memname">bool boost::geometry::side_info::touching </td>
 265           <td>(</td>
 266           <td class="paramname"></td><td>)</td>
 267           <td> const</td>
 268         </tr>
 269       </table>
 270 </div><div class="memdoc">
 271
 272 </div>
 273 </div>
 274 <a class="anchor" id="a6343f1e6ac223c409f567eaf04b8d305"></a>
 275 <div class="memitem">
 276 <div class="memproto">
 277 <div class="memtemplate">
 278 template&lt;int Which&gt; </div>
 279       <table class="memname">
 280         <tr>
 281           <td class="memname">bool boost::geometry::side_info::one_touching </td>
 282           <td>(</td>
 283           <td class="paramname"></td><td>)</td>
 284           <td> const</td>
 285         </tr>
 286       </table>
 287 </div><div class="memdoc">
 288
 289 </div>
 290 </div>
 291 <a class="anchor" id="a751a28e7b218cb229b3cb76462ebdadc"></a>
 292 <div class="memitem">
 293 <div class="memproto">
 294       <table class="memname">
 295         <tr>
 296           <td class="memname">bool boost::geometry::side_info::meeting </td>
 297           <td>(</td>
 298           <td class="paramname"></td><td>)</td>
 299           <td> const</td>
 300         </tr>
 301       </table>
 302 </div><div class="memdoc">
 303
 304 </div>
 305 </div>
 306 <a class="anchor" id="a98692676549525179f6adff4fdde7c45"></a>
 307 <div class="memitem">
 308 <div class="memproto">
 309 <div class="memtemplate">
 310 template&lt;int Which&gt; </div>
 311       <table class="memname">
 312         <tr>
 313           <td class="memname">bool boost::geometry::side_info::zero </td>
 314           <td>(</td>
 315           <td class="paramname"></td><td>)</td>
 316           <td> const</td>
 317         </tr>
 318       </table>
 319 </div><div class="memdoc">
 320
 321 </div>
 322 </div>
 323 <a class="anchor" id="a40b02d344eb55a2ed0595b18a9a02a85"></a>
 324 <div class="memitem">
 325 <div class="memproto">
 326 <div class="memtemplate">
 327 template&lt;int Which&gt; </div>
 328       <table class="memname">
 329         <tr>
 330           <td class="memname">bool boost::geometry::side_info::one_zero </td>
 331           <td>(</td>
 332           <td class="paramname"></td><td>)</td>
 333           <td> const</td>
 334         </tr>
 335       </table>
 336 </div><div class="memdoc">
 337
 338 </div>
 339 </div>
 340 <a class="anchor" id="a4216e6a8d026549fe9a434ba4b8a948b"></a>
 341 <div class="memitem">
 342 <div class="memproto">
 343       <table class="memname">
 344         <tr>
 345           <td class="memname">bool boost::geometry::side_info::one_of_all_zero </td>
 346           <td>(</td>
 347           <td class="paramname"></td><td>)</td>
 348           <td> const</td>
 349         </tr>
 350       </table>
 351 </div><div class="memdoc">
 352
 353 </div>
 354 </div>
 355 <a class="anchor" id="a091358b204c811933a29d3d2771e9287"></a>
 356 <div class="memitem">
 357 <div class="memproto">
 358 <div class="memtemplate">
 359 template&lt;int Which&gt; </div>
 360       <table class="memname">
 361         <tr>
 362           <td class="memname">int boost::geometry::side_info::zero_index </td>
 363           <td>(</td>
 364           <td class="paramname"></td><td>)</td>
 365           <td> const</td>
 366         </tr>
 367       </table>
 368 </div><div class="memdoc">
 369
 370 </div>
 371 </div>
 372 <a class="anchor" id="ac35fc700fabf86acc653a0b91e3de2b8"></a>
 373 <div class="memitem">
 374 <div class="memproto">
 375       <table class="memname">
 376         <tr>
 377           <td class="memname">void boost::geometry::side_info::reverse </td>
 378           <td>(</td>
 379           <td class="paramname"></td><td>)</td>
 380           <td></td>
 381         </tr>
 382       </table>
 383 </div><div class="memdoc">
 384
 385 </div>
 386 </div>
 387 <h2 class="groupheader">Member Data Documentation</h2>
 388 <a class="anchor" id="a5d6c4378a28c60b0b4f2f4ede892d95e"></a>
 389 <div class="memitem">
 390 <div class="memproto">
 391       <table class="memname">
 392         <tr>
 393           <td class="memname">std::pair&lt;int, int&gt; boost::geometry::side_info::sides[2]</td>
 394         </tr>
 395       </table>
 396 </div><div class="memdoc">
 397
 398 </div>
 399 </div>
 400 </div><!-- contents -->
 401 <hr size="1">
 402 <table width="100%">
 403 <tbody>
 404 <tr>
 405 <td align="left"><small>
 406 <p>April 2, 2011</p>
 407 </small></td>
 408 <td align="right">
 409 <small>
 410 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 411 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 412 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 413 </small>
 414 </td>
 415 </tr>
 416 </tbody>
 417 </table>
 418 <address style="text-align: right;"><small>
 419 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 420 </small></address>
 421 </body>
 422 </html>