libs/compute/doc/html/boost/compute/extents.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template extents</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;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp" title="Header &lt;boost/compute/utility/extents.hpp&gt;">
   9 <link rel="prev" href="dim.html" title="Function template dim">
  10 <link rel="next" href="invoke.html" title="Function template invoke">
  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="dim.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp"><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="invoke.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.extents"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template extents</span></h2>
  29 <p>boost::compute::extents</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp" title="Header &lt;boost/compute/utility/extents.hpp&gt;">boost/compute/utility/extents.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">size_t</span> N<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">size_t</span>                     <a name="boost.compute.extents.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">&gt;</span>  <a name="boost.compute.extents.array_type"></a><span class="identifier">array_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">array_type</span><span class="special">::</span><span class="identifier">iterator</span>       <a name="boost.compute.extents.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">array_type</span><span class="special">::</span><span class="identifier">const_iterator</span> <a name="boost.compute.extents.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="extents.html#boost.compute.extentsconstruct-copy-destruct">construct/copy/destruct</a></span>
  44   <a class="link" href="extents.html#idm46009691576288-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">explicit</span> <a class="link" href="extents.html#idm46009691574512-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="extents.html#idm46009691571344-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">size_t</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="extents.html#idm46009691602448-bb">public member functions</a></span>
  49   <span class="identifier">size_type</span> <a class="link" href="extents.html#idm46009691601888-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="identifier">size_type</span> <a class="link" href="extents.html#idm46009691600432-bb"><span class="identifier">linear</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51   <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idm46009691598800-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idm46009691596704-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">iterator</span> <a class="link" href="extents.html#idm46009691595040-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46009691594192-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46009691593072-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="identifier">iterator</span> <a class="link" href="extents.html#idm46009691591952-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46009691591104-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46009691589984-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idm46009691588864-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idm46009691586576-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">bool</span> <a class="link" href="extents.html#idm46009691584224-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62   <span class="keyword">bool</span> <a class="link" href="extents.html#idm46009691580336-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63
  64   <span class="comment">// public data members</span>
  65   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">static_size</span><span class="special">;</span>
  66 <span class="special">}</span><span class="special">;</span></pre></div>
  67 <div class="refsect1">
  68 <a name="idm46113315447600"></a><h2>Description</h2>
  69 <p>The extents class contains an array of n-dimensional extents.</p>
  70 <p><span class="bold"><strong>See Also:</strong></span></p>
  71 <p>dim() </p>
  72 <p>
  73 </p>
  74 <p>
  75 </p>
  76 <div class="refsect2">
  77 <a name="idm46113315445488"></a><h3>
  78 <a name="boost.compute.extentsconstruct-copy-destruct"></a><code class="computeroutput">extents</code>
  79         public
  80        construct/copy/destruct</h3>
  81 <div class="orderedlist"><ol class="orderedlist" type="1">
  82 <li class="listitem">
  83 <pre class="literallayout"><a name="idm46009691576288-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  84 <p>Creates an extents object with each component set to zero.</p>
  85 <p>For example: </p>
  86 <pre class="programlisting"><span class="identifier">extents</span><span class="special">&lt;</span><span class="number">3</span><span class="special">&gt;</span> <span class="identifier">exts</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// (0, 0, 0)</span>
  87 </pre>
  88 <p> </p>
  89 </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009691574512-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="identifier">size_t</span> value<span class="special">)</span><span class="special">;</span></pre>
  92 <p>Creates an extents object with each component set to <code class="computeroutput">value</code>.</p>
  93 <p>For example: </p>
  94 <pre class="programlisting"><span class="identifier">extents</span><span class="special">&lt;</span><span class="number">3</span><span class="special">&gt;</span> <span class="identifier">exts</span><span class="special">(</span><span class="number">1</span><span class="special">)</span><span class="special">;</span> <span class="comment">// (1, 1, 1)</span>
  95 </pre>
  96 <p> </p>
  97 </li>
  98 <li class="listitem">
  99 <pre class="literallayout"><a name="idm46009691571344-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">size_t</span> <span class="special">&gt;</span> values<span class="special">)</span><span class="special">;</span></pre>Creates an extents object with <code class="computeroutput">values</code>. </li>
 100 </ol></div>
 101 </div>
 102 <div class="refsect2">
 103 <a name="idm46113315412400"></a><h3>
 104 <a name="idm46009691602448-bb"></a><code class="computeroutput">extents</code> public member functions</h3>
 105 <div class="orderedlist"><ol class="orderedlist" type="1">
 106 <li class="listitem">
 107 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009691601888-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size (i.e. dimensionality) of the extents array. </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009691600432-bb"></a><span class="identifier">linear</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 110 <p>Returns the linear size of the extents. This is equivalent to the product of each extent in each dimension. </p>
 111 </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="identifier">size_t</span> <span class="special">*</span> <a name="idm46009691598800-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 114 <p>Returns a pointer to the extents data array.</p>
 115 <p>This is useful for passing the extents data to OpenCL APIs which expect an array of <code class="computeroutput">size_t</code>. </p>
 116 </li>
 117 <li class="listitem">
 118 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a name="idm46009691596704-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 119 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 120 </li>
 121 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46009691595040-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 122 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691594192-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 123 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691593072-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 124 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46009691591952-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 125 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691591104-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 126 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691589984-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 127 <li class="listitem">
 128 <pre class="literallayout"><span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idm46009691588864-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> index<span class="special">)</span><span class="special">;</span></pre>Returns a reference to the extent at <code class="computeroutput">index</code>. </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idm46009691586576-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> index<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 131 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009691584224-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the extents in <code class="computeroutput">*this</code> are the same as <code class="computeroutput">other</code>. </li>
 135 <li class="listitem">
 136 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009691580336-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the extents in <code class="computeroutput">*this</code> are not the same as <code class="computeroutput">other</code>. </li>
 137 </ol></div>
 138 </div>
 139 </div>
 140 </div>
 141 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 142 <td align="left"></td>
 143 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 144         Distributed under the Boost Software License, Version 1.0. (See accompanying
 145         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>)
 146       </p>
 147 </div></td>
 148 </tr></table>
 149 <hr>
 150 <div class="spirit-nav">
 151 <a accesskey="p" href="dim.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp"><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="invoke.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 152 </div>
 153 </body>
 154 </html>