arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_dimensions.xhtml
index 2f157a0..33b4c0b 100644 (file)
@@ -40,7 +40,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">ARM Compute Library
-   &#160;<span id="projectnumber">17.03.1</span>
+   &#160;<span id="projectnumber">17.04</span>
    </div>
   </td>
  </tr>
@@ -165,6 +165,24 @@ Public Member Functions</h2></td></tr>
 <tr class="memitem:a810a78f0b7cc0270f38d4136e023ea3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a810a78f0b7cc0270f38d4136e023ea3b">set_num_dimensions</a> (size_t <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a0f59f175e7682c7ed5f4ea30ef687834">num_dimensions</a>)</td></tr>
 <tr class="memdesc:a810a78f0b7cc0270f38d4136e023ea3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set number of dimensions.  <a href="#a810a78f0b7cc0270f38d4136e023ea3b">More...</a><br /></td></tr>
 <tr class="separator:a810a78f0b7cc0270f38d4136e023ea3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab2878b67ca384a699c1270900b31290b"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#ab2878b67ca384a699c1270900b31290b">begin</a> ()</td></tr>
+<tr class="memdesc:ab2878b67ca384a699c1270900b31290b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read/write iterator that points to the first element in the dimension array.  <a href="#ab2878b67ca384a699c1270900b31290b">More...</a><br /></td></tr>
+<tr class="separator:ab2878b67ca384a699c1270900b31290b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aeade0eaf149acac842e98d99d37e39c7"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#aeade0eaf149acac842e98d99d37e39c7">begin</a> () const </td></tr>
+<tr class="memdesc:aeade0eaf149acac842e98d99d37e39c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read-only (constant) iterator that points to the first element in the dimension array.  <a href="#aeade0eaf149acac842e98d99d37e39c7">More...</a><br /></td></tr>
+<tr class="separator:aeade0eaf149acac842e98d99d37e39c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4498730adaf901d945c12841df994bba"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a4498730adaf901d945c12841df994bba">cbegin</a> () const </td></tr>
+<tr class="memdesc:a4498730adaf901d945c12841df994bba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read-only (constant) iterator that points to the first element in the dimension array.  <a href="#a4498730adaf901d945c12841df994bba">More...</a><br /></td></tr>
+<tr class="separator:a4498730adaf901d945c12841df994bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac684b52c6197edff9cccb3abd1e41f59"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#ac684b52c6197edff9cccb3abd1e41f59">end</a> ()</td></tr>
+<tr class="memdesc:ac684b52c6197edff9cccb3abd1e41f59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read/write iterator that points one past the last element in the dimension array.  <a href="#ac684b52c6197edff9cccb3abd1e41f59">More...</a><br /></td></tr>
+<tr class="separator:ac684b52c6197edff9cccb3abd1e41f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a819e633cd63b404cf9938bc6e755c170"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a819e633cd63b404cf9938bc6e755c170">end</a> () const </td></tr>
+<tr class="memdesc:a819e633cd63b404cf9938bc6e755c170"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read-only (constant) iterator that points one past the last element in the dimension array.  <a href="#a819e633cd63b404cf9938bc6e755c170">More...</a><br /></td></tr>
+<tr class="separator:a819e633cd63b404cf9938bc6e755c170"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adf9b6d55d708c285d58511a780e937fc"><td class="memItemLeft" align="right" valign="top">std::array&lt; T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a> &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#adf9b6d55d708c285d58511a780e937fc">cend</a> () const </td></tr>
+<tr class="memdesc:adf9b6d55d708c285d58511a780e937fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a read-only (constant) iterator that points one past the last element in the dimension array.  <a href="#adf9b6d55d708c285d58511a780e937fc">More...</a><br /></td></tr>
+<tr class="separator:adf9b6d55d708c285d58511a780e937fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 Static Public Attributes</h2></td></tr>
@@ -255,11 +273,179 @@ class arm_compute::Dimensions&lt; T &gt;</h3>
 
 <p>Pure virtual destructor. </p>
 
-<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00125">125</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
-<div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;{</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;}</div></div><!-- fragment -->
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00156">156</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+<div class="fragment"><div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;{</div><div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;}</div></div><!-- fragment -->
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="ab2878b67ca384a699c1270900b31290b"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::iterator begin </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read/write iterator that points to the first element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00120">120</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+
+<p>Referenced by <a class="el" href="_dimensions_8h_source.xhtml#l00130">Dimensions&lt; size_t &gt;::cbegin()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    {</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        <span class="keywordflow">return</span> _id.begin();</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    }</div></div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="aeade0eaf149acac842e98d99d37e39c7"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::const_iterator begin </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read-only (constant) iterator that points to the first element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00125">125</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+<div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    {</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;        <span class="keywordflow">return</span> _id.begin();</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    }</div></div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="a4498730adaf901d945c12841df994bba"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::const_iterator cbegin </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read-only (constant) iterator that points to the first element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00130">130</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+<div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    {</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_dimensions.xhtml#ab2878b67ca384a699c1270900b31290b">begin</a>();</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_dimensions_xhtml_ab2878b67ca384a699c1270900b31290b"><div class="ttname"><a href="classarm__compute_1_1_dimensions.xhtml#ab2878b67ca384a699c1270900b31290b">arm_compute::Dimensions::begin</a></div><div class="ttdeci">std::array&lt; T, num_max_dimensions &gt;::iterator begin()</div><div class="ttdoc">Returns a read/write iterator that points to the first element in the dimension array. </div><div class="ttdef"><b>Definition:</b> <a href="_dimensions_8h_source.xhtml#l00120">Dimensions.h:120</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="adf9b6d55d708c285d58511a780e937fc"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::const_iterator cend </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read-only (constant) iterator that points one past the last element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00145">145</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+<div class="fragment"><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    {</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_dimensions.xhtml#ac684b52c6197edff9cccb3abd1e41f59">end</a>();</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_dimensions_xhtml_ac684b52c6197edff9cccb3abd1e41f59"><div class="ttname"><a href="classarm__compute_1_1_dimensions.xhtml#ac684b52c6197edff9cccb3abd1e41f59">arm_compute::Dimensions::end</a></div><div class="ttdeci">std::array&lt; T, num_max_dimensions &gt;::iterator end()</div><div class="ttdoc">Returns a read/write iterator that points one past the last element in the dimension array...</div><div class="ttdef"><b>Definition:</b> <a href="_dimensions_8h_source.xhtml#l00135">Dimensions.h:135</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="ac684b52c6197edff9cccb3abd1e41f59"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::iterator end </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read/write iterator that points one past the last element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00135">135</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+
+<p>Referenced by <a class="el" href="_dimensions_8h_source.xhtml#l00145">Dimensions&lt; size_t &gt;::cend()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;    {</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        <span class="keywordflow">return</span> _id.end();</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    }</div></div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="a819e633cd63b404cf9938bc6e755c170"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::array&lt;T, <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>&gt;::const_iterator end </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Returns a read-only (constant) iterator that points one past the last element in the dimension array. </p>
+
+<p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00140">140</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
+<div class="fragment"><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    {</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        <span class="keywordflow">return</span> _id.end();</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    }</div></div><!-- fragment -->
+</div>
+</div>
 <a class="anchor" id="a0f59f175e7682c7ed5f4ea30ef687834"></a>
 <div class="memitem">
 <div class="memproto">
@@ -285,7 +471,7 @@ class arm_compute::Dimensions&lt; T &gt;</h3>
 
 <p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00108">108</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
 
-<p>Referenced by <a class="el" href="_helpers_8h_source.xhtml#l00345">arm_compute::intersect_valid_regions()</a>, <a class="el" href="_tensor_info_8h_source.xhtml#l00239">TensorInfo::num_dimensions()</a>, and <a class="el" href="_dimensions_8h_source.xhtml#l00114">Dimensions&lt; size_t &gt;::set_num_dimensions()</a>.</p>
+<p>Referenced by <a class="el" href="_helpers_8h_source.xhtml#l00344">arm_compute::intersect_valid_regions()</a>, <a class="el" href="_tensor_info_8h_source.xhtml#l00239">TensorInfo::num_dimensions()</a>, and <a class="el" href="_dimensions_8h_source.xhtml#l00114">Dimensions&lt; size_t &gt;::set_num_dimensions()</a>.</p>
 <div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    {</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;        <span class="keywordflow">return</span> _num_dimensions;</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    }</div></div><!-- fragment -->
 </div>
 </div>
@@ -422,7 +608,7 @@ class arm_compute::Dimensions&lt; T &gt;</h3>
 
 <p>Definition at line <a class="el" href="_dimensions_8h_source.xhtml#l00073">73</a> of file <a class="el" href="_dimensions_8h_source.xhtml">Dimensions.h</a>.</p>
 
-<p>Referenced by <a class="el" href="_helpers_8h_source.xhtml#l00377">arm_compute::compute_strides()</a>, and <a class="el" href="_helpers_8h_source.xhtml#l00345">arm_compute::intersect_valid_regions()</a>.</p>
+<p>Referenced by <a class="el" href="_helpers_8h_source.xhtml#l00376">arm_compute::compute_strides()</a>, and <a class="el" href="_helpers_8h_source.xhtml#l00344">arm_compute::intersect_valid_regions()</a>.</p>
 <div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    {</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(dimension &gt;= <a class="code" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a>);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        _id[dimension]  = value;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        _num_dimensions = std::max(_num_dimensions, dimension + 1);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    }</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00100">Error.h:100</a></div></div>
 <div class="ttc" id="classarm__compute_1_1_dimensions_xhtml_a1b67d5b720119d50faa286c774579ecc"><div class="ttname"><a href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">arm_compute::Dimensions::num_max_dimensions</a></div><div class="ttdeci">static constexpr size_t num_max_dimensions</div><div class="ttdoc">Number of dimensions the tensor has. </div><div class="ttdef"><b>Definition:</b> <a href="_dimensions_8h_source.xhtml#l00045">Dimensions.h:45</a></div></div>
 </div><!-- fragment -->
@@ -574,7 +760,7 @@ class arm_compute::Dimensions&lt; T &gt;</h3>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a></li>
-    <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
+    <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
   </ul>