Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / extents.html
index 78d740d..93fd017 100644 (file)
   <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>
 
   <span class="comment">// <a class="link" href="extents.html#boost.compute.extentsconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="extents.html#idm46676579612352-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="extents.html#idm46676579610576-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>
-  <a class="link" href="extents.html#idm46676579607408-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>
+  <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>
+  <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>
+  <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>
 
-  <span class="comment">// <a class="link" href="extents.html#idm46676579638512-bb">public member functions</a></span>
-  <span class="identifier">size_type</span> <a class="link" href="extents.html#idm46676579637952-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_type</span> <a class="link" href="extents.html#idm46676579636496-bb"><span class="identifier">linear</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idm46676579634864-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idm46676579632768-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">iterator</span> <a class="link" href="extents.html#idm46676579631104-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46676579630256-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46676579629136-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">iterator</span> <a class="link" href="extents.html#idm46676579628016-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46676579627168-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idm46676579626048-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idm46676579624928-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>
-  <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idm46676579622640-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>
-  <span class="keyword">bool</span> <a class="link" href="extents.html#idm46676579620288-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>
-  <span class="keyword">bool</span> <a class="link" href="extents.html#idm46676579616400-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>
+  <span class="comment">// <a class="link" href="extents.html#idm46009691602448-bb">public member functions</a></span>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
 
   <span class="comment">// public data members</span>
   <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>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094034334320"></a><h2>Description</h2>
+<a name="idm46113315447600"></a><h2>Description</h2>
 <p>The extents class contains an array of n-dimensional extents.</p>
 <p><span class="bold"><strong>See Also:</strong></span></p>
 <p>dim() </p>
 <p>
 </p>
 <div class="refsect2">
-<a name="idm46094034332208"></a><h3>
+<a name="idm46113315445488"></a><h3>
 <a name="boost.compute.extentsconstruct-copy-destruct"></a><code class="computeroutput">extents</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676579612352-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<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>
 <p>Creates an extents object with each component set to zero.</p>
 <p>For example: </p>
 <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>
@@ -88,7 +88,7 @@
 <p> </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676579610576-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>
+<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>
 <p>Creates an extents object with each component set to <code class="computeroutput">value</code>.</p>
 <p>For example: </p>
 <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>
 <p> </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676579607408-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>
+<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>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094034299120"></a><h3>
-<a name="idm46676579638512-bb"></a><code class="computeroutput">extents</code> public member functions</h3>
+<a name="idm46113315412400"></a><h3>
+<a name="idm46009691602448-bb"></a><code class="computeroutput">extents</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46676579637952-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>
+<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>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46676579636496-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>
+<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>
 <p>Returns the linear size of the extents. This is equivalent to the product of each extent in each dimension. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <span class="special">*</span> <a name="idm46676579634864-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<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>
 <p>Returns a pointer to the extents data array.</p>
 <p>This is useful for passing the extents data to OpenCL APIs which expect an array of <code class="computeroutput">size_t</code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a name="idm46676579632768-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>
+<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>
 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 </li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46676579631104-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46676579630256-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>
-<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46676579629136-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>
-<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46676579628016-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46676579627168-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>
-<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46676579626048-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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idm46676579624928-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>
+<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>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idm46676579622640-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>
+<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>
 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46676579620288-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>
+<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>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46676579616400-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>
+<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>
 </ol></div>
 </div>
 </div>