documentation/classarm__compute_1_1_tensor_shape.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>ARM Compute Library: TensorShape Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_tensor_shape.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">TensorShape Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Shape of a tensor.
 125  <a href="classarm__compute_1_1_tensor_shape.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_tensor_shape_8h_source.xhtml">TensorShape.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for TensorShape:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_tensor_shape__coll__graph.svg" width="162" height="203"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:af156b289692f8c3f64688e9a2932ae78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#af156b289692f8c3f64688e9a2932ae78">TensorShape</a> (const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;)=default</td></tr>
 138 <tr class="memdesc:af156b289692f8c3f64688e9a2932ae78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copy constructed.  <a href="#af156b289692f8c3f64688e9a2932ae78">More...</a><br /></td></tr>
 139 <tr class="separator:af156b289692f8c3f64688e9a2932ae78"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a355b1a84ab7af3b8ef9a6bea1939450a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#a355b1a84ab7af3b8ef9a6bea1939450a">operator=</a> (const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;)=default</td></tr>
 141 <tr class="memdesc:a355b1a84ab7af3b8ef9a6bea1939450a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copied.  <a href="#a355b1a84ab7af3b8ef9a6bea1939450a">More...</a><br /></td></tr>
 142 <tr class="separator:a355b1a84ab7af3b8ef9a6bea1939450a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a5fa5abfb10a67d23a75339646e84517a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#a5fa5abfb10a67d23a75339646e84517a">TensorShape</a> (<a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&amp;)=default</td></tr>
 144 <tr class="memdesc:a5fa5abfb10a67d23a75339646e84517a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#a5fa5abfb10a67d23a75339646e84517a">More...</a><br /></td></tr>
 145 <tr class="separator:a5fa5abfb10a67d23a75339646e84517a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:afbfae7c97606fb71d556a9f4e46dda00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#afbfae7c97606fb71d556a9f4e46dda00">operator=</a> (<a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:afbfae7c97606fb71d556a9f4e46dda00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#afbfae7c97606fb71d556a9f4e46dda00">More...</a><br /></td></tr>
 148 <tr class="separator:afbfae7c97606fb71d556a9f4e46dda00"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a29ff524f0e3378fb25a8447bdeed6ba9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#a29ff524f0e3378fb25a8447bdeed6ba9">~TensorShape</a> ()=default</td></tr>
 150 <tr class="memdesc:a29ff524f0e3378fb25a8447bdeed6ba9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a29ff524f0e3378fb25a8447bdeed6ba9">More...</a><br /></td></tr>
 151 <tr class="separator:a29ff524f0e3378fb25a8447bdeed6ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a4eaec01ba2c12093db609d1034ad0bc1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#a4eaec01ba2c12093db609d1034ad0bc1">total_size</a> () const </td></tr>
 153 <tr class="memdesc:a4eaec01ba2c12093db609d1034ad0bc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collapses all dimensions to a single linear total size.  <a href="#a4eaec01ba2c12093db609d1034ad0bc1">More...</a><br /></td></tr>
 154 <tr class="separator:a4eaec01ba2c12093db609d1034ad0bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a91d8061f66e7f8bc56da91d965f04376"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml#a91d8061f66e7f8bc56da91d965f04376">total_size_upper</a> (size_t dimension) const </td></tr>
 156 <tr class="memdesc:a91d8061f66e7f8bc56da91d965f04376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collapses given dimension and above.  <a href="#a91d8061f66e7f8bc56da91d965f04376">More...</a><br /></td></tr>
 157 <tr class="separator:a91d8061f66e7f8bc56da91d965f04376"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="inherit_header pub_methods_classarm__compute_1_1_dimensions"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_dimensions')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions&lt; size_t &gt;</a></td></tr>
 159 <tr class="memitem:a0d3c59537291735849c740364496a41c inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a0d3c59537291735849c740364496a41c">Dimensions</a> (const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;)=default</td></tr>
 160 <tr class="memdesc:a0d3c59537291735849c740364496a41c inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copy constructed.  <a href="#a0d3c59537291735849c740364496a41c">More...</a><br /></td></tr>
 161 <tr class="separator:a0d3c59537291735849c740364496a41c inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:aa2c609345b3b6fa8da2486f75fff8ed8 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#aa2c609345b3b6fa8da2486f75fff8ed8">Dimensions</a> (<a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;&amp;)=default</td></tr>
 163 <tr class="memdesc:aa2c609345b3b6fa8da2486f75fff8ed8 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#aa2c609345b3b6fa8da2486f75fff8ed8">More...</a><br /></td></tr>
 164 <tr class="separator:aa2c609345b3b6fa8da2486f75fff8ed8 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:a2c96e96e2d005b4a8b66c2acd1688903 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a2c96e96e2d005b4a8b66c2acd1688903">operator=</a> (const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;)=default</td></tr>
 166 <tr class="memdesc:a2c96e96e2d005b4a8b66c2acd1688903 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copied.  <a href="#a2c96e96e2d005b4a8b66c2acd1688903">More...</a><br /></td></tr>
 167 <tr class="separator:a2c96e96e2d005b4a8b66c2acd1688903 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:a80565e11a35c48747bcc2cba06931e20 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a80565e11a35c48747bcc2cba06931e20">operator=</a> (<a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> &amp;&amp;)=default</td></tr>
 169 <tr class="memdesc:a80565e11a35c48747bcc2cba06931e20 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a80565e11a35c48747bcc2cba06931e20">More...</a><br /></td></tr>
 170 <tr class="separator:a80565e11a35c48747bcc2cba06931e20 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:ab5908ac7ee6593782fd6ec6caa0b70ff inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#ab5908ac7ee6593782fd6ec6caa0b70ff">~Dimensions</a> ()=0</td></tr>
 172 <tr class="memdesc:ab5908ac7ee6593782fd6ec6caa0b70ff inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pure virtual destructor.  <a href="#ab5908ac7ee6593782fd6ec6caa0b70ff">More...</a><br /></td></tr>
 173 <tr class="separator:ab5908ac7ee6593782fd6ec6caa0b70ff inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a982730e6f0da5f9490f59bc5f6bb3f27 inherit pub_methods_classarm__compute_1_1_dimensions"><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#a982730e6f0da5f9490f59bc5f6bb3f27">set</a> (size_t dimension, size_tvalue)</td></tr>
 175 <tr class="memdesc:a982730e6f0da5f9490f59bc5f6bb3f27 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to set the value of one of the dimensions.  <a href="#a982730e6f0da5f9490f59bc5f6bb3f27">More...</a><br /></td></tr>
 176 <tr class="separator:a982730e6f0da5f9490f59bc5f6bb3f27 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:afb5cd37bb08f1029691590372e6330f0 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#afb5cd37bb08f1029691590372e6330f0">x</a> () const</td></tr>
 178 <tr class="memdesc:afb5cd37bb08f1029691590372e6330f0 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to access the size of the first dimension.  <a href="#afb5cd37bb08f1029691590372e6330f0">More...</a><br /></td></tr>
 179 <tr class="separator:afb5cd37bb08f1029691590372e6330f0 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:a691c9cb93365c2e33f3429de43244098 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a691c9cb93365c2e33f3429de43244098">y</a> () const</td></tr>
 181 <tr class="memdesc:a691c9cb93365c2e33f3429de43244098 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to access the size of the second dimension.  <a href="#a691c9cb93365c2e33f3429de43244098">More...</a><br /></td></tr>
 182 <tr class="separator:a691c9cb93365c2e33f3429de43244098 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:a336121cb63ed79fa0a072eed03d694ac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a336121cb63ed79fa0a072eed03d694ac">z</a> () const</td></tr>
 184 <tr class="memdesc:a336121cb63ed79fa0a072eed03d694ac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to access the size of the third dimension.  <a href="#a336121cb63ed79fa0a072eed03d694ac">More...</a><br /></td></tr>
 185 <tr class="separator:a336121cb63ed79fa0a072eed03d694ac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:a67306b78d448f2ec131a237513572bac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a67306b78d448f2ec131a237513572bac">operator[]</a> (size_t dimension) const</td></tr>
 187 <tr class="memdesc:a67306b78d448f2ec131a237513572bac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic accessor to get the size of any dimension.  <a href="#a67306b78d448f2ec131a237513572bac">More...</a><br /></td></tr>
 188 <tr class="separator:a67306b78d448f2ec131a237513572bac inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:a0f59f175e7682c7ed5f4ea30ef687834 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a0f59f175e7682c7ed5f4ea30ef687834">num_dimensions</a> () const</td></tr>
 190 <tr class="memdesc:a0f59f175e7682c7ed5f4ea30ef687834 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the effective dimensionality of the tensor.  <a href="#a0f59f175e7682c7ed5f4ea30ef687834">More...</a><br /></td></tr>
 191 <tr class="separator:a0f59f175e7682c7ed5f4ea30ef687834 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:a810a78f0b7cc0270f38d4136e023ea3b inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 193 <tr class="memdesc:a810a78f0b7cc0270f38d4136e023ea3b inherit pub_methods_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set number of dimensions.  <a href="#a810a78f0b7cc0270f38d4136e023ea3b">More...</a><br /></td></tr>
 194 <tr class="separator:a810a78f0b7cc0270f38d4136e023ea3b inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 <tr class="memitem:ab2878b67ca384a699c1270900b31290b inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 196 <tr class="memdesc:ab2878b67ca384a699c1270900b31290b inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 197 <tr class="separator:ab2878b67ca384a699c1270900b31290b inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 198 <tr class="memitem:aeade0eaf149acac842e98d99d37e39c7 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 199 <tr class="memdesc:aeade0eaf149acac842e98d99d37e39c7 inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 200 <tr class="separator:aeade0eaf149acac842e98d99d37e39c7 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 201 <tr class="memitem:a4498730adaf901d945c12841df994bba inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 202 <tr class="memdesc:a4498730adaf901d945c12841df994bba inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 203 <tr class="separator:a4498730adaf901d945c12841df994bba inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 204 <tr class="memitem:ac684b52c6197edff9cccb3abd1e41f59 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 205 <tr class="memdesc:ac684b52c6197edff9cccb3abd1e41f59 inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 206 <tr class="separator:ac684b52c6197edff9cccb3abd1e41f59 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 207 <tr class="memitem:a819e633cd63b404cf9938bc6e755c170 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 208 <tr class="memdesc:a819e633cd63b404cf9938bc6e755c170 inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 209 <tr class="separator:a819e633cd63b404cf9938bc6e755c170 inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 210 <tr class="memitem:adf9b6d55d708c285d58511a780e937fc inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">std::array&lt; size_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>
 211 <tr class="memdesc:adf9b6d55d708c285d58511a780e937fc inherit pub_methods_classarm__compute_1_1_dimensions"><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>
 212 <tr class="separator:adf9b6d55d708c285d58511a780e937fc inherit pub_methods_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 213 </table><table class="memberdecls">
 214 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 215 Additional Inherited Members</h2></td></tr>
 216 <tr class="inherit_header pub_static_attribs_classarm__compute_1_1_dimensions"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classarm__compute_1_1_dimensions')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions&lt; size_t &gt;</a></td></tr>
 217 <tr class="memitem:a1b67d5b720119d50faa286c774579ecc inherit pub_static_attribs_classarm__compute_1_1_dimensions"><td class="memItemLeft" align="right" valign="top">static constexpr size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc">num_max_dimensions</a></td></tr>
 218 <tr class="memdesc:a1b67d5b720119d50faa286c774579ecc inherit pub_static_attribs_classarm__compute_1_1_dimensions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of dimensions the tensor has.  <a href="#a1b67d5b720119d50faa286c774579ecc">More...</a><br /></td></tr>
 219 <tr class="separator:a1b67d5b720119d50faa286c774579ecc inherit pub_static_attribs_classarm__compute_1_1_dimensions"><td class="memSeparator" colspan="2">&#160;</td></tr>
 220 </table>
 221 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 222 <div class="textblock"><p>Shape of a tensor. </p>
 223
 224 <p>Definition at line <a class="el" href="_tensor_shape_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_tensor_shape_8h_source.xhtml">TensorShape.h</a>.</p>
 225 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 226 <a class="anchor" id="af156b289692f8c3f64688e9a2932ae78"></a>
 227 <div class="memitem">
 228 <div class="memproto">
 229 <table class="mlabels">
 230   <tr>
 231   <td class="mlabels-left">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> </td>
 235           <td>(</td>
 236           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
 237           <td class="paramname"></td><td>)</td>
 238           <td></td>
 239         </tr>
 240       </table>
 241   </td>
 242   <td class="mlabels-right">
 243 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 244   </tr>
 245 </table>
 246 </div><div class="memdoc">
 247
 248 <p>Allow instances of this class to be copy constructed. </p>
 249
 250 </div>
 251 </div>
 252 <a class="anchor" id="a5fa5abfb10a67d23a75339646e84517a"></a>
 253 <div class="memitem">
 254 <div class="memproto">
 255 <table class="mlabels">
 256   <tr>
 257   <td class="mlabels-left">
 258       <table class="memname">
 259         <tr>
 260           <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> </td>
 261           <td>(</td>
 262           <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&amp;&#160;</td>
 263           <td class="paramname"></td><td>)</td>
 264           <td></td>
 265         </tr>
 266       </table>
 267   </td>
 268   <td class="mlabels-right">
 269 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 270   </tr>
 271 </table>
 272 </div><div class="memdoc">
 273
 274 <p>Allow instances of this class to be move constructed. </p>
 275
 276 </div>
 277 </div>
 278 <a class="anchor" id="a29ff524f0e3378fb25a8447bdeed6ba9"></a>
 279 <div class="memitem">
 280 <div class="memproto">
 281 <table class="mlabels">
 282   <tr>
 283   <td class="mlabels-left">
 284       <table class="memname">
 285         <tr>
 286           <td class="memname">~<a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> </td>
 287           <td>(</td>
 288           <td class="paramname"></td><td>)</td>
 289           <td></td>
 290         </tr>
 291       </table>
 292   </td>
 293   <td class="mlabels-right">
 294 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 295   </tr>
 296 </table>
 297 </div><div class="memdoc">
 298
 299 <p>Default destructor. </p>
 300
 301 </div>
 302 </div>
 303 <h2 class="groupheader">Member Function Documentation</h2>
 304 <a class="anchor" id="a355b1a84ab7af3b8ef9a6bea1939450a"></a>
 305 <div class="memitem">
 306 <div class="memproto">
 307 <table class="mlabels">
 308   <tr>
 309   <td class="mlabels-left">
 310       <table class="memname">
 311         <tr>
 312           <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a>&amp; operator= </td>
 313           <td>(</td>
 314           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
 315           <td class="paramname"></td><td>)</td>
 316           <td></td>
 317         </tr>
 318       </table>
 319   </td>
 320   <td class="mlabels-right">
 321 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 322   </tr>
 323 </table>
 324 </div><div class="memdoc">
 325
 326 <p>Allow instances of this class to be copied. </p>
 327
 328 </div>
 329 </div>
 330 <a class="anchor" id="afbfae7c97606fb71d556a9f4e46dda00"></a>
 331 <div class="memitem">
 332 <div class="memproto">
 333 <table class="mlabels">
 334   <tr>
 335   <td class="mlabels-left">
 336       <table class="memname">
 337         <tr>
 338           <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a>&amp; operator= </td>
 339           <td>(</td>
 340           <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&amp;&#160;</td>
 341           <td class="paramname"></td><td>)</td>
 342           <td></td>
 343         </tr>
 344       </table>
 345   </td>
 346   <td class="mlabels-right">
 347 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 348   </tr>
 349 </table>
 350 </div><div class="memdoc">
 351
 352 <p>Allow instances of this class to be moved. </p>
 353
 354 </div>
 355 </div>
 356 <a class="anchor" id="a4eaec01ba2c12093db609d1034ad0bc1"></a>
 357 <div class="memitem">
 358 <div class="memproto">
 359 <table class="mlabels">
 360   <tr>
 361   <td class="mlabels-left">
 362       <table class="memname">
 363         <tr>
 364           <td class="memname">size_t total_size </td>
 365           <td>(</td>
 366           <td class="paramname"></td><td>)</td>
 367           <td> const</td>
 368         </tr>
 369       </table>
 370   </td>
 371   <td class="mlabels-right">
 372 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 373   </tr>
 374 </table>
 375 </div><div class="memdoc">
 376
 377 <p>Collapses all dimensions to a single linear total size. </p>
 378 <dl class="section return"><dt>Returns</dt><dd>The total tensor size in terms of elements. </dd></dl>
 379
 380 <p>Definition at line <a class="el" href="_tensor_shape_8h_source.xhtml#l00068">68</a> of file <a class="el" href="_tensor_shape_8h_source.xhtml">TensorShape.h</a>.</p>
 381
 382 <p>References <a class="el" href="accumulate_8cl_source.xhtml#l00041">accumulate()</a>, and <a class="el" href="_error_8h_source.xhtml#l00100">ARM_COMPUTE_ERROR_ON</a>.</p>
 383 <div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    {</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">size_t</span> size = <a class="code" href="accumulate_8cl.xhtml#a00e540076dd545ad59ac7482f8cdf514">std::accumulate</a>(_id.begin(), _id.end(), 1, std::multiplies&lt;size_t&gt;());</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(0 == size);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        <span class="keywordflow">return</span> size;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</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>
 384 <div class="ttc" id="accumulate_8cl_xhtml_a00e540076dd545ad59ac7482f8cdf514"><div class="ttname"><a href="accumulate_8cl.xhtml#a00e540076dd545ad59ac7482f8cdf514">accumulate</a></div><div class="ttdeci">__kernel void accumulate(__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uchar *accu_ptr, uint accu_stride_x, uint accu_step_x, uint accu_stride_y, uint accu_step_y, uint accu_offset_first_element_in_bytes)</div><div class="ttdoc">This function accumulates an input image into output image. </div><div class="ttdef"><b>Definition:</b> <a href="accumulate_8cl_source.xhtml#l00041">accumulate.cl:41</a></div></div>
 385 </div><!-- fragment -->
 386 </div>
 387 </div>
 388 <a class="anchor" id="a91d8061f66e7f8bc56da91d965f04376"></a>
 389 <div class="memitem">
 390 <div class="memproto">
 391 <table class="mlabels">
 392   <tr>
 393   <td class="mlabels-left">
 394       <table class="memname">
 395         <tr>
 396           <td class="memname">size_t total_size_upper </td>
 397           <td>(</td>
 398           <td class="paramtype">size_t&#160;</td>
 399           <td class="paramname"><em>dimension</em></td><td>)</td>
 400           <td> const</td>
 401         </tr>
 402       </table>
 403   </td>
 404   <td class="mlabels-right">
 405 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 406   </tr>
 407 </table>
 408 </div><div class="memdoc">
 409
 410 <p>Collapses given dimension and above. </p>
 411 <dl class="section note"><dt>Note</dt><dd>Precondition: dimension &lt; <a class="el" href="classarm__compute_1_1_dimensions.xhtml#a1b67d5b720119d50faa286c774579ecc" title="Number of dimensions the tensor has. ">TensorShape::num_max_dimensions</a></dd></dl>
 412 <dl class="params"><dt>Parameters</dt><dd>
 413   <table class="params">
 414     <tr><td class="paramdir">[in]</td><td class="paramname">dimension</td><td>Size of the wanted dimension</td></tr>
 415   </table>
 416   </dd>
 417 </dl>
 418 <dl class="section return"><dt>Returns</dt><dd>The linear size of the collapsed dimensions </dd></dl>
 419
 420 <p>Definition at line <a class="el" href="_tensor_shape_8h_source.xhtml#l00082">82</a> of file <a class="el" href="_tensor_shape_8h_source.xhtml">TensorShape.h</a>.</p>
 421
 422 <p>References <a class="el" href="accumulate_8cl_source.xhtml#l00041">accumulate()</a>, and <a class="el" href="_error_8h_source.xhtml#l00100">ARM_COMPUTE_ERROR_ON</a>.</p>
 423 <div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    {</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">size_t</span> size = <a class="code" href="accumulate_8cl.xhtml#a00e540076dd545ad59ac7482f8cdf514">std::accumulate</a>(_id.begin() + dimension, _id.end(), 1, std::multiplies&lt;size_t&gt;());</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(0 == size);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        <span class="keywordflow">return</span> size;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</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>
 424 <div class="ttc" id="accumulate_8cl_xhtml_a00e540076dd545ad59ac7482f8cdf514"><div class="ttname"><a href="accumulate_8cl.xhtml#a00e540076dd545ad59ac7482f8cdf514">accumulate</a></div><div class="ttdeci">__kernel void accumulate(__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uchar *accu_ptr, uint accu_stride_x, uint accu_step_x, uint accu_stride_y, uint accu_step_y, uint accu_offset_first_element_in_bytes)</div><div class="ttdoc">This function accumulates an input image into output image. </div><div class="ttdef"><b>Definition:</b> <a href="accumulate_8cl_source.xhtml#l00041">accumulate.cl:41</a></div></div>
 425 </div><!-- fragment -->
 426 </div>
 427 </div>
 428 <hr/>The documentation for this class was generated from the following file:<ul>
 429 <li>arm_compute/core/<a class="el" href="_tensor_shape_8h_source.xhtml">TensorShape.h</a></li>
 430 </ul>
 431 </div><!-- contents -->
 432 </div><!-- doc-content -->
 433 <!-- start footer part -->
 434 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 435   <ul>
 436     <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_tensor_shape.xhtml">TensorShape</a></li>
 437     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 438     <a href="http://www.doxygen.org/index.html">
 439     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 440   </ul>
 441 </div>
 442 </body>
 443 </html>