libs/geometry/doc/html/geometry/reference/de9im/de9im_matrix.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>de9im::matrix</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="../de9im.html" title="DE-9IM">
   9 <link rel="prev" href="de9im_mask.html" title="de9im::mask">
  10 <link rel="next" href="de9im_static_mask.html" title="de9im::static_mask">
  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="de9im_mask.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../de9im.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="de9im_static_mask.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.de9im.de9im_matrix"></a><a class="link" href="de9im_matrix.html" title="de9im::matrix">de9im::matrix</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186985646800"></a><a class="indexterm" name="idm46186985646112"></a>
  31 DE-9IM model intersection matrix.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.de9im.de9im_matrix.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.description"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.description">Description</a>
  36         </h6>
  37 <p>
  38           This matrix can be used to express spatial relations as defined in Dimensionally
  39           Extended 9-Intersection Model.
  40         </p>
  41 <h6>
  42 <a name="geometry.reference.de9im.de9im_matrix.h1"></a>
  43           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.synopsis"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.synopsis">Synopsis</a>
  44         </h6>
  45 <p>
  46 </p>
  47 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">de9im</span><span class="special">::</span><span class="identifier">matrix</span>
  48       <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">relate</span><span class="special">::</span><span class="identifier">matrix</span><span class="special">&lt;</span> <span class="number">3</span><span class="special">,</span> <span class="number">3</span> <span class="special">&gt;</span>
  49 <span class="special">{</span>
  50   <span class="comment">// ...</span>
  51 <span class="special">};</span>
  52 </pre>
  53 <p>
  54         </p>
  55 <h6>
  56 <a name="geometry.reference.de9im.de9im_matrix.h2"></a>
  57           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.constructor_s_"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.constructor_s_">Constructor(s)</a>
  58         </h6>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                   <p>
  68                     Function
  69                   </p>
  70                 </th>
  71 <th>
  72                   <p>
  73                     Description
  74                   </p>
  75                 </th>
  76 <th>
  77                   <p>
  78                     Parameters
  79                   </p>
  80                 </th>
  81 </tr></thead>
  82 <tbody><tr>
  83 <td>
  84                   <p>
  85 </p>
  86 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">matrix</span><span class="special">()</span></pre>
  87 <p>
  88                   </p>
  89                 </td>
  90 <td>
  91                   <p>
  92                     Initializes all of the matrix elements to F.
  93                   </p>
  94                 </td>
  95 <td>
  96                 </td>
  97 </tr></tbody>
  98 </table></div>
  99 <h6>
 100 <a name="geometry.reference.de9im.de9im_matrix.h3"></a>
 101           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.member_function_s_"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.member_function_s_">Member
 102           Function(s)</a>
 103         </h6>
 104 <div class="informaltable"><table class="table">
 105 <colgroup>
 106 <col>
 107 <col>
 108 <col>
 109 <col>
 110 </colgroup>
 111 <thead><tr>
 112 <th>
 113                   <p>
 114                     Function
 115                   </p>
 116                 </th>
 117 <th>
 118                   <p>
 119                     Description
 120                   </p>
 121                 </th>
 122 <th>
 123                   <p>
 124                     Parameters
 125                   </p>
 126                 </th>
 127 <th>
 128                   <p>
 129                     Returns
 130                   </p>
 131                 </th>
 132 </tr></thead>
 133 <tbody>
 134 <tr>
 135 <td>
 136                   <p>
 137 </p>
 138 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">char</span> <span class="keyword">operator</span><span class="special">[](</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">index</span><span class="special">)</span></pre>
 139 <p>
 140                   </p>
 141                 </td>
 142 <td>
 143                   <p>
 144                     Subscript operator.
 145                   </p>
 146                 </td>
 147 <td>
 148                   <p>
 149                     <span class="bold"><strong>std::size_t</strong></span>: <span class="emphasis"><em>index</em></span>:
 150                     The index of the element
 151                   </p>
 152                 </td>
 153 <td>
 154                   <p>
 155                     The element
 156                   </p>
 157                 </td>
 158 </tr>
 159 <tr>
 160 <td>
 161                   <p>
 162 </p>
 163 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">const_iterator</span> <span class="identifier">begin</span><span class="special">()</span></pre>
 164 <p>
 165                   </p>
 166                 </td>
 167 <td>
 168                   <p>
 169                     Returns the iterator to the first element.
 170                   </p>
 171                 </td>
 172 <td>
 173                 </td>
 174 <td>
 175                   <p>
 176                     const RandomAccessIterator
 177                   </p>
 178                 </td>
 179 </tr>
 180 <tr>
 181 <td>
 182                   <p>
 183 </p>
 184 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">const_iterator</span> <span class="identifier">end</span><span class="special">()</span></pre>
 185 <p>
 186                   </p>
 187                 </td>
 188 <td>
 189                   <p>
 190                     Returns the iterator past the last element.
 191                   </p>
 192                 </td>
 193 <td>
 194                 </td>
 195 <td>
 196                   <p>
 197                     const RandomAccessIterator
 198                   </p>
 199                 </td>
 200 </tr>
 201 <tr>
 202 <td>
 203                   <p>
 204 </p>
 205 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">()</span></pre>
 206 <p>
 207                   </p>
 208                 </td>
 209 <td>
 210                   <p>
 211                     Returns the number of elements.
 212                   </p>
 213                 </td>
 214 <td>
 215                 </td>
 216 <td>
 217                   <p>
 218                     9
 219                   </p>
 220                 </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                   <p>
 225 </p>
 226 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="identifier">data</span><span class="special">()</span></pre>
 227 <p>
 228                   </p>
 229                 </td>
 230 <td>
 231                   <p>
 232                     Returns raw pointer to elements.
 233                   </p>
 234                 </td>
 235 <td>
 236                 </td>
 237 <td>
 238                   <p>
 239                     const pointer to array of elements
 240                   </p>
 241                 </td>
 242 </tr>
 243 <tr>
 244 <td>
 245                   <p>
 246 </p>
 247 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">str</span><span class="special">()</span></pre>
 248 <p>
 249                   </p>
 250                 </td>
 251 <td>
 252                   <p>
 253                     Returns std::string containing elements.
 254                   </p>
 255                 </td>
 256 <td>
 257                 </td>
 258 <td>
 259                   <p>
 260                     string containing elements
 261                   </p>
 262                 </td>
 263 </tr>
 264 </tbody>
 265 </table></div>
 266 <h6>
 267 <a name="geometry.reference.de9im.de9im_matrix.h4"></a>
 268           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.header"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.header">Header</a>
 269         </h6>
 270 <p>
 271           <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">algorithms</span><span class="special">/</span><span class="identifier">detail</span><span class="special">/</span><span class="identifier">relate</span><span class="special">/</span><span class="identifier">de9im</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 272         </p>
 273 <h6>
 274 <a name="geometry.reference.de9im.de9im_matrix.h5"></a>
 275           <span class="phrase"><a name="geometry.reference.de9im.de9im_matrix.see_also"></a></span><a class="link" href="de9im_matrix.html#geometry.reference.de9im.de9im_matrix.see_also">See
 276           also</a>
 277         </h6>
 278 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 279               <a class="link" href="../algorithms/relation.html" title="relation">relation</a>
 280             </li></ul></div>
 281 </div>
 282 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 283 <td align="left"></td>
 284 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 285       Wulkiewicz, Oracle and/or its affiliates<p>
 286         Distributed under the Boost Software License, Version 1.0. (See accompanying
 287         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>)
 288       </p>
 289 </div></td>
 290 </tr></table>
 291 <hr>
 292 <div class="spirit-nav">
 293 <a accesskey="p" href="de9im_mask.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../de9im.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="de9im_static_mask.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 294 </div>
 295 </body>
 296 </html>