Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 1 | <!-- HTML header for doxygen 1.8.17--> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 9 | <title>Arm NN: src/backends/reference/workloads/TensorBufferArrayView.hpp Source File</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 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 18 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 19 | <script type="text/javascript" src="search/search.js"></script> |
| 20 | <script type="text/x-mathjax-config"> |
| 21 | MathJax.Hub.Config({ |
| 22 | extensions: ["tex2jax.js"], |
| 23 | jax: ["input/TeX","output/HTML-CSS"], |
| 24 | }); |
| 25 | </script> |
| 26 | <script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| 27 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 28 | <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> |
| 29 | </head> |
| 30 | <body> |
| 31 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 32 | <div id="titlearea"> |
| 33 | <table cellspacing="0" cellpadding="0"> |
| 34 | <tbody> |
| 35 | <tr style="height: 56px;"> |
| 36 | <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/> |
| 37 | <td id="projectalign" style="padding-left: 0.9em;"> |
| 38 | <div id="projectname"> |
| 39 |  <span id="projectnumber">24.05</span> |
| 40 | </div> |
| 41 | </td> |
| 42 | </tr> |
| 43 | </tbody> |
| 44 | </table> |
| 45 | </div> |
| 46 | <!-- end header part --> |
| 47 | <!-- Generated by Doxygen 1.8.17 --> |
| 48 | <script type="text/javascript"> |
| 49 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 50 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 51 | /* @license-end */ |
| 52 | </script> |
| 53 | <script type="text/javascript" src="menudata.js"></script> |
| 54 | <script type="text/javascript" src="menu.js"></script> |
| 55 | <script type="text/javascript"> |
| 56 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 57 | $(function() { |
| 58 | initMenu('',true,false,'search.php','Search'); |
| 59 | $(document).ready(function() { init_search(); }); |
| 60 | }); |
| 61 | /* @license-end */</script> |
| 62 | <div id="main-nav"></div> |
| 63 | </div><!-- top --> |
| 64 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 65 | <div id="nav-tree"> |
| 66 | <div id="nav-tree-contents"> |
| 67 | <div id="nav-sync" class="sync"></div> |
| 68 | </div> |
| 69 | </div> |
| 70 | <div id="splitbar" style="-moz-user-select:none;" |
| 71 | class="ui-resizable-handle"> |
| 72 | </div> |
| 73 | </div> |
| 74 | <script type="text/javascript"> |
| 75 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 76 | $(document).ready(function(){initNavTree('_tensor_buffer_array_view_8hpp_source.html',''); initResizable(); }); |
| 77 | /* @license-end */ |
| 78 | </script> |
| 79 | <div id="doc-content"> |
| 80 | <!-- window showing the filter options --> |
| 81 | <div id="MSearchSelectWindow" |
| 82 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 83 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 84 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 85 | </div> |
| 86 | |
| 87 | <!-- iframe showing the search results (closed by default) --> |
| 88 | <div id="MSearchResultsWindow"> |
| 89 | <iframe src="javascript:void(0)" frameborder="0" |
| 90 | name="MSearchResults" id="MSearchResults"> |
| 91 | </iframe> |
| 92 | </div> |
| 93 | |
| 94 | <div class="header"> |
| 95 | <div class="headertitle"> |
| 96 | <div class="title">TensorBufferArrayView.hpp</div> </div> |
| 97 | </div><!--header--> |
| 98 | <div class="contents"> |
| 99 | <a href="_tensor_buffer_array_view_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> |
| 100 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2017, 2024 Arm Ltd. All rights reserved.</span></div> |
| 101 | <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div> |
| 102 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> |
| 103 | <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div> |
| 104 | <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div> |
| 105 | <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div> |
| 106 | <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="_tensor_8hpp.html">armnn/Tensor.hpp</a>></span></div> |
| 107 | <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div> |
| 108 | <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <<a class="code" href="_data_layout_indexed_8hpp.html">armnnUtils/DataLayoutIndexed.hpp</a>></span></div> |
| 109 | <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div> |
| 110 | <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div> |
| 111 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div> |
| 112 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div> |
| 113 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// Utility class providing access to raw tensor memory based on indices along each dimension.</span></div> |
| 114 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">template</span> <<span class="keyword">typename</span> DataType></div> |
| 115 | <div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classarmnn_1_1_tensor_buffer_array_view.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_tensor_buffer_array_view.html">TensorBufferArrayView</a></div> |
| 116 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div> |
| 117 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div> |
| 118 | <div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_tensor_buffer_array_view.html#a1f2ab1d90881eb1bbd76729949559a55"> 20</a></span>  <a class="code" href="classarmnn_1_1_tensor_buffer_array_view.html#a1f2ab1d90881eb1bbd76729949559a55">TensorBufferArrayView</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_tensor_shape.html">TensorShape</a>& shape, <a class="code" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>* data,</div> |
| 119 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="classarmnn_utils_1_1_data_layout_indexed.html">armnnUtils::DataLayoutIndexed</a> dataLayout = <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">DataLayout::NCHW</a>)</div> |
| 120 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  : m_Shape(shape)</div> |
| 121 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  , m_Data(data)</div> |
| 122 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  , m_DataLayout(dataLayout)</div> |
| 123 | <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  {</div> |
| 124 | <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="_exceptions_8hpp.html#a5b0cd1f24b12298894d6367f186ea6dc">ARMNN_THROW_INVALIDARG_MSG_IF_FALSE</a>(m_Shape.<a class="code" href="classarmnn_1_1_tensor_shape.html#a157e27d41e9f6b21f0d3c025fa47dc24">GetNumDimensions</a>() == 4,</div> |
| 125 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="stringliteral">"Only $d tensors are supported by TensorBufferArrayView."</span>);</div> |
| 126 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div> |
| 127 | <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| 128 | <div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classarmnn_1_1_tensor_buffer_array_view.html#ab3a2cf851173535ea07b9d87eaf3ca01"> 30</a></span>  <a class="code" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>& <a class="code" href="classarmnn_1_1_tensor_buffer_array_view.html#ab3a2cf851173535ea07b9d87eaf3ca01">Get</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> b, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> w)<span class="keyword"> const</span></div> |
| 129 | <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword"> </span>{</div> |
| 130 | <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> m_Data[m_DataLayout.<a class="code" href="classarmnn_utils_1_1_data_layout_indexed.html#a1e25d8623da985a43597b5756c73b206">GetIndex</a>(m_Shape, b, c, h, w)];</div> |
| 131 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div> |
| 132 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> |
| 133 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">private</span>:</div> |
| 134 | <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_tensor_shape.html">TensorShape</a> m_Shape;</div> |
| 135 | <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>* m_Data;</div> |
| 136 | <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classarmnn_utils_1_1_data_layout_indexed.html">armnnUtils::DataLayoutIndexed</a> m_DataLayout;</div> |
| 137 | <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div> |
| 138 | <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> |
| 139 | <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <span class="comment">//namespace armnn</span></div> |
| 140 | </div><!-- fragment --></div><!-- contents --> |
| 141 | </div><!-- doc-content --> |
| 142 | <div class="ttc" id="aclassarmnn_1_1_tensor_buffer_array_view_html_a1f2ab1d90881eb1bbd76729949559a55"><div class="ttname"><a href="classarmnn_1_1_tensor_buffer_array_view.html#a1f2ab1d90881eb1bbd76729949559a55">armnn::TensorBufferArrayView::TensorBufferArrayView</a></div><div class="ttdeci">TensorBufferArrayView(const TensorShape &shape, DataType *data, armnnUtils::DataLayoutIndexed dataLayout=DataLayout::NCHW)</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_buffer_array_view_8hpp_source.html#l00020">TensorBufferArrayView.hpp:20</a></div></div> |
| 143 | <div class="ttc" id="aclassarmnn_utils_1_1_data_layout_indexed_html"><div class="ttname"><a href="classarmnn_utils_1_1_data_layout_indexed.html">armnnUtils::DataLayoutIndexed</a></div><div class="ttdoc">Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout.</div><div class="ttdef"><b>Definition:</b> <a href="_data_layout_indexed_8hpp_source.html#l00017">DataLayoutIndexed.hpp:17</a></div></div> |
| 144 | <div class="ttc" id="aclassarmnn_1_1_tensor_shape_html"><div class="ttname"><a href="classarmnn_1_1_tensor_shape.html">armnn::TensorShape</a></div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8hpp_source.html#l00020">Tensor.hpp:20</a></div></div> |
| 145 | <div class="ttc" id="aclassarmnn_1_1_tensor_shape_html_a157e27d41e9f6b21f0d3c025fa47dc24"><div class="ttname"><a href="classarmnn_1_1_tensor_shape.html#a157e27d41e9f6b21f0d3c025fa47dc24">armnn::TensorShape::GetNumDimensions</a></div><div class="ttdeci">unsigned int GetNumDimensions() const</div><div class="ttdoc">Function that returns the tensor rank.</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8cpp_source.html#l00174">Tensor.cpp:174</a></div></div> |
| 146 | <div class="ttc" id="anamespacearmnn_html_ad8ed01ff3ff33333d8e19db4d2818bb6"><div class="ttname"><a href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">armnn::DataType</a></div><div class="ttdeci">DataType</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00048">Types.hpp:48</a></div></div> |
| 147 | <div class="ttc" id="a_tensor_8hpp_html"><div class="ttname"><a href="_tensor_8hpp.html">Tensor.hpp</a></div></div> |
| 148 | <div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div> |
| 149 | <div class="ttc" id="aclassarmnn_1_1_tensor_buffer_array_view_html_ab3a2cf851173535ea07b9d87eaf3ca01"><div class="ttname"><a href="classarmnn_1_1_tensor_buffer_array_view.html#ab3a2cf851173535ea07b9d87eaf3ca01">armnn::TensorBufferArrayView::Get</a></div><div class="ttdeci">DataType & Get(unsigned int b, unsigned int c, unsigned int h, unsigned int w) const</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_buffer_array_view_8hpp_source.html#l00030">TensorBufferArrayView.hpp:30</a></div></div> |
| 150 | <div class="ttc" id="aclassarmnn_1_1_tensor_buffer_array_view_html"><div class="ttname"><a href="classarmnn_1_1_tensor_buffer_array_view.html">armnn::TensorBufferArrayView</a></div><div class="ttdef"><b>Definition:</b> <a href="_tensor_buffer_array_view_8hpp_source.html#l00017">TensorBufferArrayView.hpp:17</a></div></div> |
| 151 | <div class="ttc" id="aclassarmnn_utils_1_1_data_layout_indexed_html_a1e25d8623da985a43597b5756c73b206"><div class="ttname"><a href="classarmnn_utils_1_1_data_layout_indexed.html#a1e25d8623da985a43597b5756c73b206">armnnUtils::DataLayoutIndexed::GetIndex</a></div><div class="ttdeci">unsigned int GetIndex(const armnn::TensorShape &shape, unsigned int batchIndex, unsigned int channelIndex, unsigned int heightIndex, unsigned int widthIndex) const</div><div class="ttdef"><b>Definition:</b> <a href="_data_layout_indexed_8hpp_source.html#l00028">DataLayoutIndexed.hpp:28</a></div></div> |
| 152 | <div class="ttc" id="a_data_layout_indexed_8hpp_html"><div class="ttname"><a href="_data_layout_indexed_8hpp.html">DataLayoutIndexed.hpp</a></div></div> |
| 153 | <div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div><div class="ttdeci">@ NCHW</div></div> |
| 154 | <div class="ttc" id="a_exceptions_8hpp_html_a5b0cd1f24b12298894d6367f186ea6dc"><div class="ttname"><a href="_exceptions_8hpp.html#a5b0cd1f24b12298894d6367f186ea6dc">ARMNN_THROW_INVALIDARG_MSG_IF_FALSE</a></div><div class="ttdeci">#define ARMNN_THROW_INVALIDARG_MSG_IF_FALSE(_cond, _str)</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00210">Exceptions.hpp:210</a></div></div> |
| 155 | <!-- start footer part --> |
| 156 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 157 | <ul> |
| 158 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.html">backends</a></li><li class="navelem"><a class="el" href="dir_efae4012d0e357ebeaba7d02491d70e5.html">reference</a></li><li class="navelem"><a class="el" href="dir_d2f3b8e2e64df3181ebe92efcc0a3012.html">workloads</a></li><li class="navelem"><a class="el" href="_tensor_buffer_array_view_8hpp.html">TensorBufferArrayView.hpp</a></li> |
| 159 | <li class="footer">Generated on Thu May 16 2024 09:31:49 for Arm NN by |
| 160 | <a href="http://www.doxygen.org/index.html"> |
| 161 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> |
| 162 | </ul> |
| 163 | </div> |
| 164 | </body> |
| 165 | </html> |