libs/geometry/doc/html/geometry/reference/adapted/c_array.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>C array</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../adapted.html" title="Adapted models">
   9 <link rel="prev" href="../adapted.html" title="Adapted models">
  10 <link rel="next" href="boost_array.html" title="Boost.Array">
  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="../adapted.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.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="boost_array.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.adapted.c_array"></a><a class="link" href="c_array.html" title="C array">C array</a>
  28 </h4></div></div></div>
  29 <p>
  30           C arrays are adapted to the Boost.Geometry point concept
  31         </p>
  32 <h6>
  33 <a name="geometry.reference.adapted.c_array.h0"></a>
  34           <span><a name="geometry.reference.adapted.c_array.description"></a></span><a class="link" href="c_array.html#geometry.reference.adapted.c_array.description">Description</a>
  35         </h6>
  36 <p>
  37           C arrays, such as double[2] or int[3], are (optionally) adapted to the
  38           Boost.Geometry point concept. They can therefore be used in many Boost.Geometry
  39           algorithms.
  40         </p>
  41 <p>
  42           Note that a C array cannot be the point type of a linestring or a polygon.
  43           The reason for that is that a std::vector does not allow containing C arrays
  44           (this is not related to Boost.Geometry). The C array is therefore limited
  45           to the point type.
  46         </p>
  47 <h6>
  48 <a name="geometry.reference.adapted.c_array.h1"></a>
  49           <span><a name="geometry.reference.adapted.c_array.model_of"></a></span><a class="link" href="c_array.html#geometry.reference.adapted.c_array.model_of">Model
  50           of</a>
  51         </h6>
  52 <p>
  53           <a class="link" href="../concepts/concept_point.html" title="Point Concept">Point Concept</a>
  54         </p>
  55 <h6>
  56 <a name="geometry.reference.adapted.c_array.h2"></a>
  57           <span><a name="geometry.reference.adapted.c_array.header"></a></span><a class="link" href="c_array.html#geometry.reference.adapted.c_array.header">Header</a>
  58         </h6>
  59 <p>
  60           <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">geometries</span><span class="special">/</span><span class="identifier">adapted</span><span class="special">/</span><span class="identifier">c_array</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  61         </p>
  62 <p>
  63           The standard header <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span></code>
  64           does not include this header.
  65         </p>
  66 <h6>
  67 <a name="geometry.reference.adapted.c_array.h3"></a>
  68           <span><a name="geometry.reference.adapted.c_array.example"></a></span><a class="link" href="c_array.html#geometry.reference.adapted.c_array.example">Example</a>
  69         </h6>
  70 <p>
  71           Small example showing the combination of an array with a Boost.Geometry
  72           algorithm
  73         </p>
  74 <p>
  75 </p>
  76 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
  77 <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>
  78 <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">adapted</span><span class="special">/</span><span class="identifier">c_array</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  79
  80 <span class="identifier">BOOST_GEOMETRY_REGISTER_C_ARRAY_CS</span><span class="special">(</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">)</span>
  81
  82 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
  83 <span class="special">{</span>
  84     <span class="keyword">int</span> <span class="identifier">a</span><span class="special">[</span><span class="number">3</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">};</span>
  85     <span class="keyword">int</span> <span class="identifier">b</span><span class="special">[</span><span class="number">3</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span><span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">4</span><span class="special">};</span>
  86
  87     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">a</span><span class="special">,</span> <span class="identifier">b</span><span class="special">)</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>
  88
  89     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
  90 <span class="special">}</span>
  91 </pre>
  92 <p>
  93         </p>
  94 <p>
  95           Output:
  96         </p>
  97 <pre class="programlisting">1.73205
  98 </pre>
  99 </div>
 100 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 101 <td align="left"></td>
 102 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Barend
 103       Gehrels, Bruno Lalande, Mateusz Loskot<p>
 104         Distributed under the Boost Software License, Version 1.0. (See accompanying
 105         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>)
 106       </p>
 107 </div></td>
 108 </tr></table>
 109 <hr>
 110 <div class="spirit-nav">
 111 <a accesskey="p" href="../adapted.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.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="boost_array.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 112 </div>
 113 </body>
 114 </html>