libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1model_1_1point.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_1model.html">model</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">point</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="classboost_1_1geometry_1_1model_1_1point-members.html">List of all members</a>  </div>
  53   <div class="headertitle">
  54 <div class="title">boost::geometry::model::point&lt; CoordinateType, DimensionCount, CoordinateSystem &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__geometries.html">geometries: geometries provided by default</a></div></div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57
  58 <p>Basic point class, having coordinates defined in a neutral way.
  59  <a href="classboost_1_1geometry_1_1model_1_1point.html#details">More...</a></p>
  60 <table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  62 Public Member Functions</h2></td></tr>
  63 <tr class="memitem:a5042d74b21e525743168c56563ddf015"><td class="memTemplParams" colspan="2">template&lt;std::size_t K&gt; </td></tr>
  64 <tr class="memitem:a5042d74b21e525743168c56563ddf015"><td class="memTemplItemLeft" align="right" valign="top">CoordinateType const &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#a5042d74b21e525743168c56563ddf015">get</a> () const </td></tr>
  65 <tr class="memdesc:a5042d74b21e525743168c56563ddf015"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a coordinate.  <a href="#a5042d74b21e525743168c56563ddf015">More...</a><br/></td></tr>
  66 <tr class="separator:a5042d74b21e525743168c56563ddf015"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:a768fcbb0028e80ee4579a47f5d058370"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#a768fcbb0028e80ee4579a47f5d058370">point</a> ()=default</td></tr>
  68 <tr class="memdesc:a768fcbb0028e80ee4579a47f5d058370"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor, no initialization.  <a href="#a768fcbb0028e80ee4579a47f5d058370">More...</a><br/></td></tr>
  69 <tr class="separator:a768fcbb0028e80ee4579a47f5d058370"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:a0236fd6973659285b15292d9370e9136"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#a0236fd6973659285b15292d9370e9136">point</a> (CoordinateType const &amp;v0)</td></tr>
  71 <tr class="memdesc:a0236fd6973659285b15292d9370e9136"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to set one value.  <a href="#a0236fd6973659285b15292d9370e9136">More...</a><br/></td></tr>
  72 <tr class="separator:a0236fd6973659285b15292d9370e9136"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:abe00d79aa3ed9be100f1a34b7d09249b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#abe00d79aa3ed9be100f1a34b7d09249b">point</a> (CoordinateType const &amp;v0, CoordinateType const &amp;v1)</td></tr>
  74 <tr class="memdesc:abe00d79aa3ed9be100f1a34b7d09249b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to set two values.  <a href="#abe00d79aa3ed9be100f1a34b7d09249b">More...</a><br/></td></tr>
  75 <tr class="separator:abe00d79aa3ed9be100f1a34b7d09249b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:a2d74ab12275dd09e47b50ab941f71e58"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#a2d74ab12275dd09e47b50ab941f71e58">point</a> (CoordinateType const &amp;v0, CoordinateType const &amp;v1, CoordinateType const &amp;v2)</td></tr>
  77 <tr class="memdesc:a2d74ab12275dd09e47b50ab941f71e58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to set three values.  <a href="#a2d74ab12275dd09e47b50ab941f71e58">More...</a><br/></td></tr>
  78 <tr class="separator:a2d74ab12275dd09e47b50ab941f71e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:adc88778b0d7c9e70aeeed0981c003a67"><td class="memTemplParams" colspan="2">template&lt;std::size_t K&gt; </td></tr>
  80 <tr class="memitem:adc88778b0d7c9e70aeeed0981c003a67"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html#adc88778b0d7c9e70aeeed0981c003a67">set</a> (CoordinateType const &amp;value)</td></tr>
  81 <tr class="memdesc:adc88778b0d7c9e70aeeed0981c003a67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a coordinate.  <a href="#adc88778b0d7c9e70aeeed0981c003a67">More...</a><br/></td></tr>
  82 <tr class="separator:adc88778b0d7c9e70aeeed0981c003a67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 </table>
  84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85 <div class="textblock"><h3>template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt;<br/>
  86 class boost::geometry::model::point&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;</h3>
  87
  88 <p>Basic point class, having coordinates defined in a neutral way. </p>
  89 <p>Defines a neutral point class, fulfilling the Point Concept. Library users can use this point class, or use their own point classes. This point class is used in most of the samples and tests of Boost.Geometry This point class is used occasionally within the library, where a temporary point class is necessary.</p>
  90 <dl class="tparams"><dt>Template Parameters</dt><dd>
  91   <table class="tparams">
  92     <tr><td class="paramname">CoordinateType</td><td>numerical type (int, double, ttmath, ...) </td></tr>
  93     <tr><td class="paramname">DimensionCount</td><td>number of coordinates, usually 2 or 3 </td></tr>
  94     <tr><td class="paramname">CoordinateSystem</td><td>coordinate system, for example <a class="el" href="structboost_1_1geometry_1_1cs_1_1cartesian.html" title="Cartesian coordinate system. ">cs::cartesian</a></td></tr>
  95   </table>
  96   </dd>
  97 </dl>
  98    <dl><dt><b>Examples: </b></dt><dd><a class="el" href="01_point_example_8cpp-example.html#_a3">01_point_example.cpp</a>, <a class="el" href="02_linestring_example_8cpp-example.html#_a20">02_linestring_example.cpp</a>, <a class="el" href="07_a_graph_route_example_8cpp-example.html#_a10">07_a_graph_route_example.cpp</a>, <a class="el" href="07_b_graph_route_example_8cpp-example.html#_a9">07_b_graph_route_example.cpp</a>, and <a class="el" href="x03_b_soci_example_8cpp-example.html#_a0">x03_b_soci_example.cpp</a>.</dd>
  99 </dl></div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 100 <a class="anchor" id="a768fcbb0028e80ee4579a47f5d058370"></a>
 101 <div class="memitem">
 102 <div class="memproto">
 103 <div class="memtemplate">
 104 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 105 <table class="mlabels">
 106   <tr>
 107   <td class="mlabels-left">
 108       <table class="memname">
 109         <tr>
 110           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">point</a> </td>
 111           <td>(</td>
 112           <td class="paramname"></td><td>)</td>
 113           <td></td>
 114         </tr>
 115       </table>
 116   </td>
 117   <td class="mlabels-right">
 118 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 119   </tr>
 120 </table>
 121 </div><div class="memdoc">
 122
 123 <p>Default constructor, no initialization. </p>
 124
 125 </div>
 126 </div>
 127 <a class="anchor" id="a0236fd6973659285b15292d9370e9136"></a>
 128 <div class="memitem">
 129 <div class="memproto">
 130 <div class="memtemplate">
 131 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 132 <table class="mlabels">
 133   <tr>
 134   <td class="mlabels-left">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">point</a> </td>
 138           <td>(</td>
 139           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 140           <td class="paramname"><em>v0</em></td><td>)</td>
 141           <td></td>
 142         </tr>
 143       </table>
 144   </td>
 145   <td class="mlabels-right">
 146 <span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
 147   </tr>
 148 </table>
 149 </div><div class="memdoc">
 150
 151 <p>Constructor to set one value. </p>
 152
 153 </div>
 154 </div>
 155 <a class="anchor" id="abe00d79aa3ed9be100f1a34b7d09249b"></a>
 156 <div class="memitem">
 157 <div class="memproto">
 158 <div class="memtemplate">
 159 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 160       <table class="memname">
 161         <tr>
 162           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">point</a> </td>
 163           <td>(</td>
 164           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 165           <td class="paramname"><em>v0</em>, </td>
 166         </tr>
 167         <tr>
 168           <td class="paramkey"></td>
 169           <td></td>
 170           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 171           <td class="paramname"><em>v1</em>&#160;</td>
 172         </tr>
 173         <tr>
 174           <td></td>
 175           <td>)</td>
 176           <td></td><td></td>
 177         </tr>
 178       </table>
 179 </div><div class="memdoc">
 180
 181 <p>Constructor to set two values. </p>
 182
 183 </div>
 184 </div>
 185 <a class="anchor" id="a2d74ab12275dd09e47b50ab941f71e58"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188 <div class="memtemplate">
 189 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 190       <table class="memname">
 191         <tr>
 192           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">point</a> </td>
 193           <td>(</td>
 194           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 195           <td class="paramname"><em>v0</em>, </td>
 196         </tr>
 197         <tr>
 198           <td class="paramkey"></td>
 199           <td></td>
 200           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 201           <td class="paramname"><em>v1</em>, </td>
 202         </tr>
 203         <tr>
 204           <td class="paramkey"></td>
 205           <td></td>
 206           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 207           <td class="paramname"><em>v2</em>&#160;</td>
 208         </tr>
 209         <tr>
 210           <td></td>
 211           <td>)</td>
 212           <td></td><td></td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216
 217 <p>Constructor to set three values. </p>
 218
 219 </div>
 220 </div>
 221 <h2 class="groupheader">Member Function Documentation</h2>
 222 <a class="anchor" id="a5042d74b21e525743168c56563ddf015"></a>
 223 <div class="memitem">
 224 <div class="memproto">
 225 <div class="memtemplate">
 226 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 227 <div class="memtemplate">
 228 template&lt;std::size_t K&gt; </div>
 229       <table class="memname">
 230         <tr>
 231           <td class="memname">CoordinateType const&amp; <a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::get </td>
 232           <td>(</td>
 233           <td class="paramname"></td><td>)</td>
 234           <td> const</td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238
 239 <p>Get a coordinate. </p>
 240 <dl class="tparams"><dt>Template Parameters</dt><dd>
 241   <table class="tparams">
 242     <tr><td class="paramname">K</td><td>coordinate to get </td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246 <dl class="section return"><dt>Returns</dt><dd>the coordinate </dd></dl>
 247
 248 </div>
 249 </div>
 250 <a class="anchor" id="adc88778b0d7c9e70aeeed0981c003a67"></a>
 251 <div class="memitem">
 252 <div class="memproto">
 253 <div class="memtemplate">
 254 template&lt;typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem&gt; </div>
 255 <div class="memtemplate">
 256 template&lt;std::size_t K&gt; </div>
 257       <table class="memname">
 258         <tr>
 259           <td class="memname">void <a class="el" href="classboost_1_1geometry_1_1model_1_1point.html">boost::geometry::model::point</a>&lt; CoordinateType, DimensionCount, CoordinateSystem &gt;::set </td>
 260           <td>(</td>
 261           <td class="paramtype">CoordinateType const &amp;&#160;</td>
 262           <td class="paramname"><em>value</em></td><td>)</td>
 263           <td></td>
 264         </tr>
 265       </table>
 266 </div><div class="memdoc">
 267
 268 <p>Set a coordinate. </p>
 269 <dl class="tparams"><dt>Template Parameters</dt><dd>
 270   <table class="tparams">
 271     <tr><td class="paramname">K</td><td>coordinate to set </td></tr>
 272   </table>
 273   </dd>
 274 </dl>
 275 <dl class="params"><dt>Parameters</dt><dd>
 276   <table class="params">
 277     <tr><td class="paramname">value</td><td>value to set </td></tr>
 278   </table>
 279   </dd>
 280 </dl>
 281
 282 </div>
 283 </div>
 284 </div><!-- contents -->
 285 <hr size="1">
 286 <table width="100%">
 287 <tbody>
 288 <tr>
 289 <td align="left"><small>
 290 <p>April 2, 2011</p>
 291 </small></td>
 292 <td align="right">
 293 <small>
 294 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 295 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 296 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 297 </small>
 298 </td>
 299 </tr>
 300 </tbody>
 301 </table>
 302 <address style="text-align: right;"><small>
 303 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 304 </small></address>
 305 </body>
 306 </html>