libs/geometry/doc/html/geometry/reference/access/get/get_1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>get</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../get.html" title="get">
   9 <link rel="prev" href="../get.html" title="get">
  10 <link rel="next" href="get_1_with_index.html" title="get (with index)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../get.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_1_with_index.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="geometry.reference.access.get.get_1"></a><a class="link" href="get_1.html" title="get">get</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46187014731360"></a>
  31 Get coordinate value of a geometry (usually a point)
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.access.get.get_1.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.access.get.get_1.description"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.description">Description</a>
  36           </h6>
  37 <p>
  38             The free functions <span class="bold"><strong>get</strong></span> and <span class="bold"><strong>set</strong></span> are two of the most important functions of
  39             Boost.Geometry, both within the library, as also for the library user.
  40             With these two functions you normally get and set coordinate values from
  41             and for a point, box, segment or sphere.
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.access.get.get_1.h1"></a>
  45             <span class="phrase"><a name="geometry.reference.access.get.get_1.synopsis"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.synopsis">Synopsis</a>
  46           </h6>
  47 <p>
  48 </p>
  49 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">Dimension</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
  50 <span class="identifier">coordinate_type</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
  51 <p>
  52           </p>
  53 <h6>
  54 <a name="geometry.reference.access.get.get_1.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.access.get.get_1.parameters"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.parameters">Parameters</a>
  56           </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                     <p>
  67                       Type
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Concept
  73                     </p>
  74                   </th>
  75 <th>
  76                     <p>
  77                       Name
  78                     </p>
  79                   </th>
  80 <th>
  81                     <p>
  82                       Description
  83                     </p>
  84                   </th>
  85 </tr></thead>
  86 <tbody>
  87 <tr>
  88 <td>
  89                     <p>
  90                       Dimension
  91                     </p>
  92                   </td>
  93 <td>
  94                     <p>
  95                       Dimension, this template parameter is required. Should contain
  96                       [0 .. n-1] for an n-dimensional geometry
  97                     </p>
  98                   </td>
  99 <td>
 100                     <p>
 101                       -
 102                     </p>
 103                   </td>
 104 <td>
 105                     <p>
 106                       Must be specified
 107                     </p>
 108                   </td>
 109 </tr>
 110 <tr>
 111 <td>
 112                     <p>
 113                       Geometry const &amp;
 114                     </p>
 115                   </td>
 116 <td>
 117                     <p>
 118                       Any type fulfilling a Geometry Concept (usually a Point Concept)
 119                     </p>
 120                   </td>
 121 <td>
 122                     <p>
 123                       geometry
 124                     </p>
 125                   </td>
 126 <td>
 127                     <p>
 128                       A model of the specified concept (usually a point)
 129                     </p>
 130                   </td>
 131 </tr>
 132 </tbody>
 133 </table></div>
 134 <h6>
 135 <a name="geometry.reference.access.get.get_1.h3"></a>
 136             <span class="phrase"><a name="geometry.reference.access.get.get_1.returns"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.returns">Returns</a>
 137           </h6>
 138 <p>
 139             The coordinate value of specified dimension of specified geometry
 140           </p>
 141 <h6>
 142 <a name="geometry.reference.access.get.get_1.h4"></a>
 143             <span class="phrase"><a name="geometry.reference.access.get.get_1.header"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.header">Header</a>
 144           </h6>
 145 <p>
 146             Either
 147           </p>
 148 <p>
 149             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 150           </p>
 151 <p>
 152             Or
 153           </p>
 154 <p>
 155             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">core</span><span class="special">/</span><span class="identifier">access</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 156           </p>
 157 <h6>
 158 <a name="geometry.reference.access.get.get_1.h5"></a>
 159             <span class="phrase"><a name="geometry.reference.access.get.get_1.behavior"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.behavior">Behavior</a>
 160           </h6>
 161 <div class="informaltable"><table class="table">
 162 <colgroup>
 163 <col>
 164 <col>
 165 </colgroup>
 166 <thead><tr>
 167 <th>
 168                     <p>
 169                       Case
 170                     </p>
 171                   </th>
 172 <th>
 173                     <p>
 174                       Behavior
 175                     </p>
 176                   </th>
 177 </tr></thead>
 178 <tbody>
 179 <tr>
 180 <td>
 181                     <p>
 182                       Point
 183                     </p>
 184                   </td>
 185 <td>
 186                     <p>
 187                       Returns the coordinate of a point
 188                     </p>
 189                   </td>
 190 </tr>
 191 <tr>
 192 <td>
 193                     <p>
 194                       Circle or Sphere
 195                     </p>
 196                   </td>
 197 <td>
 198                     <p>
 199                       Returns the coordinate of the center of a circle or sphere
 200                       (currently in an extension)
 201                     </p>
 202                   </td>
 203 </tr>
 204 <tr>
 205 <td>
 206                     <p>
 207                       Spherical
 208                     </p>
 209                   </td>
 210 <td>
 211                     <p>
 212                       Returns the coordinate of a point, in either Radian's or Degree's,
 213                       depending on specified units
 214                     </p>
 215                   </td>
 216 </tr>
 217 </tbody>
 218 </table></div>
 219 <h6>
 220 <a name="geometry.reference.access.get.get_1.h6"></a>
 221             <span class="phrase"><a name="geometry.reference.access.get.get_1.complexity"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.complexity">Complexity</a>
 222           </h6>
 223 <p>
 224             Constant
 225           </p>
 226 <h6>
 227 <a name="geometry.reference.access.get.get_1.h7"></a>
 228             <span class="phrase"><a name="geometry.reference.access.get.get_1.example"></a></span><a class="link" href="get_1.html#geometry.reference.access.get.get_1.example">Example</a>
 229           </h6>
 230 <p>
 231             Get the coordinate of a point
 232           </p>
 233 <p>
 234 </p>
 235 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 236
 237 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 238 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 239
 240 <span class="keyword">namespace</span> <span class="identifier">bg</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span>
 241
 242 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 243 <span class="special">{</span>
 244     <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">);</span>
 245
 246     <span class="keyword">double</span> <span class="identifier">x</span> <span class="special">=</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">get</span><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">point</span><span class="special">);</span>
 247     <span class="keyword">double</span> <span class="identifier">y</span> <span class="special">=</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">get</span><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">point</span><span class="special">);</span>
 248
 249     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"x="</span> <span class="special">&lt;&lt;</span> <span class="identifier">x</span> <span class="special">&lt;&lt;</span> <span class="string">" y="</span> <span class="special">&lt;&lt;</span> <span class="identifier">y</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 250
 251     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 252 <span class="special">}</span>
 253 </pre>
 254 <p>
 255           </p>
 256 <p>
 257             Output:
 258           </p>
 259 <pre class="programlisting">x=1 y=2
 260 </pre>
 261 </div>
 262 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 263 <td align="left"></td>
 264 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 265       Wulkiewicz, Oracle and/or its affiliates<p>
 266         Distributed under the Boost Software License, Version 1.0. (See accompanying
 267         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 268       </p>
 269 </div></td>
 270 </tr></table>
 271 <hr>
 272 <div class="spirit-nav">
 273 <a accesskey="p" href="../get.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_1_with_index.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 274 </div>
 275 </body>
 276 </html>