Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 7ddbbae7ad3e0000d8e6a76458cac68254dc8048 / . / Documentation / classarmnn_utils_1_1_data_layout_indexed.xhtml
blob: c67647991950b3554c1252f74cf51748b915444f [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: DataLayoutIndexed Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_utils_1_1_data_layout_indexed.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_utils_1_1_data_layout_indexed-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">DataLayoutIndexed Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p>Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout.
106 <a href="classarmnn_utils_1_1_data_layout_indexed.xhtml#details">More...</a></p>
107
108<p><code>#include &lt;<a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>&gt;</code></p>
109<table class="memberdecls">
110<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
111Public Member Functions</h2></td></tr>
112<tr class="memitem:ac9468c3774c559c52844025b8bbb5a97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#ac9468c3774c559c52844025b8bbb5a97">DataLayoutIndexed</a> (<a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a> dataLayout)</td></tr>
113<tr class="separator:ac9468c3774c559c52844025b8bbb5a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:a7d8b3d755b6ca8f5533657969efb06c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#a7d8b3d755b6ca8f5533657969efb06c4">GetDataLayout</a> () const</td></tr>
115<tr class="separator:a7d8b3d755b6ca8f5533657969efb06c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a861b2621ee46e4b63379988b360b8cd9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#a861b2621ee46e4b63379988b360b8cd9">GetChannelsIndex</a> () const</td></tr>
117<tr class="separator:a861b2621ee46e4b63379988b360b8cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:a61c00316c443adc233c24e85c6c5b740"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#a61c00316c443adc233c24e85c6c5b740">GetHeightIndex</a> () const</td></tr>
119<tr class="separator:a61c00316c443adc233c24e85c6c5b740"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a414e6f95548e6f7a01d5028b55ad3941"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#a414e6f95548e6f7a01d5028b55ad3941">GetWidthIndex</a> () const</td></tr>
121<tr class="separator:a414e6f95548e6f7a01d5028b55ad3941"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a1e25d8623da985a43597b5756c73b206"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml#a1e25d8623da985a43597b5756c73b206">GetIndex</a> (const <a class="el" href="classarmnn_1_1_tensor_shape.xhtml">armnn::TensorShape</a> &amp;shape, unsigned int batchIndex, unsigned int channelIndex, unsigned int heightIndex, unsigned int widthIndex) const</td></tr>
123<tr class="separator:a1e25d8623da985a43597b5756c73b206"><td class="memSeparator" colspan="2">&#160;</td></tr>
124</table>
125<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
126<div class="textblock"><p>Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout. </p>
127
128<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00017">17</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
129</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130<a id="ac9468c3774c559c52844025b8bbb5a97"></a>
131<h2 class="memtitle"><span class="permalink"><a href="#ac9468c3774c559c52844025b8bbb5a97">&#9670;&nbsp;</a></span>DataLayoutIndexed()</h2>
132
133<div class="memitem">
134<div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml">DataLayoutIndexed</a> </td>
138 <td>(</td>
139 <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a>&#160;</td>
140 <td class="paramname"><em>dataLayout</em></td><td>)</td>
141 <td></td>
142 </tr>
143 </table>
144</div><div class="memdoc">
145
146<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8cpp_source.xhtml#l00013">13</a> of file <a class="el" href="_data_layout_indexed_8cpp_source.xhtml">DataLayoutIndexed.cpp</a>.</p>
147
148<p class="reference">References <a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::NCHW</a>, and <a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::NHWC</a>.</p>
149<div class="fragment"><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; : m_DataLayout(dataLayout)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordflow">switch</span> (dataLayout)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; m_ChannelsIndex = 3;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; m_HeightIndex = 1;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; m_WidthIndex = 2;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">break</span>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; m_ChannelsIndex = 1;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_HeightIndex = 2;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; m_WidthIndex = 3;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">break</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">default</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.xhtml">armnn::InvalidArgumentException</a>(<span class="stringliteral">&quot;Unknown DataLayout value: &quot;</span> +</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; std::to_string(static_cast&lt;int&gt;(dataLayout)));</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_invalid_argument_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_invalid_argument_exception.xhtml">armnn::InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00080">Exceptions.hpp:80</a></div></div>
150<div class="ttc" id="namespacearmnn_xhtml_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div></div>
151<div class="ttc" id="namespacearmnn_xhtml_ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51"><div class="ttname"><a href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a></div></div>
152</div><!-- fragment -->
153</div>
154</div>
155<h2 class="groupheader">Member Function Documentation</h2>
156<a id="a861b2621ee46e4b63379988b360b8cd9"></a>
157<h2 class="memtitle"><span class="permalink"><a href="#a861b2621ee46e4b63379988b360b8cd9">&#9670;&nbsp;</a></span>GetChannelsIndex()</h2>
158
159<div class="memitem">
160<div class="memproto">
161<table class="mlabels">
162 <tr>
163 <td class="mlabels-left">
164 <table class="memname">
165 <tr>
166 <td class="memname">unsigned int GetChannelsIndex </td>
167 <td>(</td>
168 <td class="paramname"></td><td>)</td>
169 <td> const</td>
170 </tr>
171 </table>
172 </td>
173 <td class="mlabels-right">
174<span class="mlabels"><span class="mlabel">inline</span></span> </td>
175 </tr>
176</table>
177</div><div class="memdoc">
178
179<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00023">23</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
180
181<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.xhtml#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00035">armnn::BatchToSpaceNd()</a>, <a class="el" href="_conv_impl_8cpp_source.xhtml#l00071">armnn::Convolve()</a>, <a class="el" href="_depth_to_space_8cpp_source.xhtml#l00018">armnn::DepthToSpace()</a>, <a class="el" href="_conv2d_test_impl_8cpp_source.xhtml#l00122">GetBias()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00015">armnn::GetOffset()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.xhtml#l00039">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.xhtml#l00038">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_resize_layer_8cpp_source.xhtml#l00037">ResizeLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.xhtml#l00018">armnn::InstanceNorm()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00019">armnn::Offset()</a>, <a class="el" href="_pooling2d_8cpp_source.xhtml#l00143">armnn::Pooling2d()</a>, <a class="el" href="_resize_8cpp_source.xhtml#l00035">armnn::Resize()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00034">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.xhtml#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.xhtml#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01343">ResizeBilinearQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01391">ResizeQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01603">SpaceToBatchNdQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01669">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.xhtml#l03005">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
182<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{ <span class="keywordflow">return</span> m_ChannelsIndex; }</div></div><!-- fragment -->
183</div>
184</div>
185<a id="a7d8b3d755b6ca8f5533657969efb06c4"></a>
186<h2 class="memtitle"><span class="permalink"><a href="#a7d8b3d755b6ca8f5533657969efb06c4">&#9670;&nbsp;</a></span>GetDataLayout()</h2>
187
188<div class="memitem">
189<div class="memproto">
190<table class="mlabels">
191 <tr>
192 <td class="mlabels-left">
193 <table class="memname">
194 <tr>
195 <td class="memname"><a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a> GetDataLayout </td>
196 <td>(</td>
197 <td class="paramname"></td><td>)</td>
198 <td> const</td>
199 </tr>
200 </table>
201 </td>
202 <td class="mlabels-right">
203<span class="mlabels"><span class="mlabel">inline</span></span> </td>
204 </tr>
205</table>
206</div><div class="memdoc">
207
208<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00022">22</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
209
210<p class="reference">Referenced by <a class="el" href="_conv2d_test_impl_8cpp_source.xhtml#l02669">CompareDepthwiseConvolution2dTestImpl()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00015">armnn::GetOffset()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00019">armnn::Offset()</a>, and <a class="el" href="_data_layout_indexed_8cpp_source.xhtml#l00034">armnnUtils::operator==()</a>.</p>
211<div class="fragment"><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{ <span class="keywordflow">return</span> m_DataLayout; }</div></div><!-- fragment -->
212</div>
213</div>
214<a id="a61c00316c443adc233c24e85c6c5b740"></a>
215<h2 class="memtitle"><span class="permalink"><a href="#a61c00316c443adc233c24e85c6c5b740">&#9670;&nbsp;</a></span>GetHeightIndex()</h2>
216
217<div class="memitem">
218<div class="memproto">
219<table class="mlabels">
220 <tr>
221 <td class="mlabels-left">
222 <table class="memname">
223 <tr>
224 <td class="memname">unsigned int GetHeightIndex </td>
225 <td>(</td>
226 <td class="paramname"></td><td>)</td>
227 <td> const</td>
228 </tr>
229 </table>
230 </td>
231 <td class="mlabels-right">
232<span class="mlabels"><span class="mlabel">inline</span></span> </td>
233 </tr>
234</table>
235</div><div class="memdoc">
236
237<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
238
239<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.xhtml#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00035">armnn::BatchToSpaceNd()</a>, <a class="el" href="_tf_parser_8cpp_source.xhtml#l00933">armnnTfParser::ConvertTfTensorDataType()</a>, <a class="el" href="_conv_impl_8cpp_source.xhtml#l00071">armnn::Convolve()</a>, <a class="el" href="_depth_to_space_8cpp_source.xhtml#l00018">armnn::DepthToSpace()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00015">armnn::GetOffset()</a>, <a class="el" href="_space_to_batch_nd_layer_8cpp_source.xhtml#l00042">SpaceToBatchNdLayer::InferOutputShapes()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.xhtml#l00039">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.xhtml#l00038">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_batch_to_space_nd_layer_8cpp_source.xhtml#l00057">BatchToSpaceNdLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.xhtml#l00018">armnn::InstanceNorm()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00019">armnn::Offset()</a>, <a class="el" href="_tf_parser_8cpp_source.xhtml#l02463">armnnTfParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_pooling2d_8cpp_source.xhtml#l00143">armnn::Pooling2d()</a>, <a class="el" href="_resize_8cpp_source.xhtml#l00035">armnn::Resize()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.xhtml#l00029">Convolution2dLayer::SerializeLayerParameters()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00034">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.xhtml#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.xhtml#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01603">SpaceToBatchNdQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01669">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.xhtml#l03005">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
240<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{ <span class="keywordflow">return</span> m_HeightIndex; }</div></div><!-- fragment -->
241</div>
242</div>
243<a id="a1e25d8623da985a43597b5756c73b206"></a>
244<h2 class="memtitle"><span class="permalink"><a href="#a1e25d8623da985a43597b5756c73b206">&#9670;&nbsp;</a></span>GetIndex()</h2>
245
246<div class="memitem">
247<div class="memproto">
248<table class="mlabels">
249 <tr>
250 <td class="mlabels-left">
251 <table class="memname">
252 <tr>
253 <td class="memname">unsigned int GetIndex </td>
254 <td>(</td>
255 <td class="paramtype">const <a class="el" href="classarmnn_1_1_tensor_shape.xhtml">armnn::TensorShape</a> &amp;&#160;</td>
256 <td class="paramname"><em>shape</em>, </td>
257 </tr>
258 <tr>
259 <td class="paramkey"></td>
260 <td></td>
261 <td class="paramtype">unsigned int&#160;</td>
262 <td class="paramname"><em>batchIndex</em>, </td>
263 </tr>
264 <tr>
265 <td class="paramkey"></td>
266 <td></td>
267 <td class="paramtype">unsigned int&#160;</td>
268 <td class="paramname"><em>channelIndex</em>, </td>
269 </tr>
270 <tr>
271 <td class="paramkey"></td>
272 <td></td>
273 <td class="paramtype">unsigned int&#160;</td>
274 <td class="paramname"><em>heightIndex</em>, </td>
275 </tr>
276 <tr>
277 <td class="paramkey"></td>
278 <td></td>
279 <td class="paramtype">unsigned int&#160;</td>
280 <td class="paramname"><em>widthIndex</em>&#160;</td>
281 </tr>
282 <tr>
283 <td></td>
284 <td>)</td>
285 <td></td><td> const</td>
286 </tr>
287 </table>
288 </td>
289 <td class="mlabels-right">
290<span class="mlabels"><span class="mlabel">inline</span></span> </td>
291 </tr>
292</table>
293</div><div class="memdoc">
294<p>Offset the given indices appropriately depending on the data layout</p>
295<p>channelIndex stays unchanged</p>
296<p>widthIndex stays unchanged</p>
297<p>Get the value using the correct offset </p>
298
299<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00027">27</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
300
301<p class="reference">References <a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::NCHW</a>, <a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::NHWC</a>, and <a class="el" href="_data_layout_indexed_8cpp_source.xhtml#l00034">armnnUtils::operator==()</a>.</p>
302
303<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.xhtml#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_conv_impl_8cpp_source.xhtml#l00071">armnn::Convolve()</a>, <a class="el" href="_tensor_buffer_array_view_8hpp_source.xhtml#l00031">TensorBufferArrayView&lt; DataType &gt;::Get()</a>, <a class="el" href="_instance_norm_8cpp_source.xhtml#l00018">armnn::InstanceNorm()</a>, <a class="el" href="_pooling2d_8cpp_source.xhtml#l00143">armnn::Pooling2d()</a>, <a class="el" href="_resize_8cpp_source.xhtml#l00035">armnn::Resize()</a>, and <a class="el" href="_transpose_convolution2d_8cpp_source.xhtml#l00015">armnn::TransposeConvolution2dImpl()</a>.</p>
304<div class="fragment"><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; BOOST_ASSERT( batchIndex &lt; shape[0] || ( shape[0] == 0 &amp;&amp; batchIndex == 0 ) );</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; BOOST_ASSERT( channelIndex &lt; shape[m_ChannelsIndex] ||</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; ( shape[m_ChannelsIndex] == 0 &amp;&amp; channelIndex == 0) );</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; BOOST_ASSERT( heightIndex &lt; shape[m_HeightIndex] ||</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; ( shape[m_HeightIndex] == 0 &amp;&amp; heightIndex == 0) );</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; BOOST_ASSERT( widthIndex &lt; shape[m_WidthIndex] ||</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; ( shape[m_WidthIndex] == 0 &amp;&amp; widthIndex == 0) );</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> /// Offset the given indices appropriately depending on the data layout</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span> <span class="keywordflow">switch</span> (m_DataLayout)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; batchIndex *= shape[1] * shape[2] * shape[3]; <span class="comment">// batchIndex *= heightIndex * widthIndex * channelIndex</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; heightIndex *= shape[m_WidthIndex] * shape[m_ChannelsIndex];</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; widthIndex *= shape[m_ChannelsIndex];<span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> /// channelIndex stays unchanged</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"></span> <span class="keywordflow">break</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">default</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; batchIndex *= shape[1] * shape[2] * shape[3]; <span class="comment">// batchIndex *= heightIndex * widthIndex * channelIndex</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; channelIndex *= shape[m_HeightIndex] * shape[m_WidthIndex];</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; heightIndex *= shape[m_WidthIndex];<span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> /// widthIndex stays unchanged</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"></span> <span class="keywordflow">break</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> /// Get the value using the correct offset</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"></span> <span class="keywordflow">return</span> batchIndex + channelIndex + heightIndex + widthIndex;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="ttc" id="namespacearmnn_xhtml_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div></div>
305<div class="ttc" id="namespacearmnn_xhtml_ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51"><div class="ttname"><a href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a></div></div>
306</div><!-- fragment -->
307</div>
308</div>
309<a id="a414e6f95548e6f7a01d5028b55ad3941"></a>
310<h2 class="memtitle"><span class="permalink"><a href="#a414e6f95548e6f7a01d5028b55ad3941">&#9670;&nbsp;</a></span>GetWidthIndex()</h2>
311
312<div class="memitem">
313<div class="memproto">
314<table class="mlabels">
315 <tr>
316 <td class="mlabels-left">
317 <table class="memname">
318 <tr>
319 <td class="memname">unsigned int GetWidthIndex </td>
320 <td>(</td>
321 <td class="paramname"></td><td>)</td>
322 <td> const</td>
323 </tr>
324 </table>
325 </td>
326 <td class="mlabels-right">
327<span class="mlabels"><span class="mlabel">inline</span></span> </td>
328 </tr>
329</table>
330</div><div class="memdoc">
331
332<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.xhtml#l00025">25</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a>.</p>
333
334<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.xhtml#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00035">armnn::BatchToSpaceNd()</a>, <a class="el" href="_tf_parser_8cpp_source.xhtml#l00933">armnnTfParser::ConvertTfTensorDataType()</a>, <a class="el" href="_conv_impl_8cpp_source.xhtml#l00071">armnn::Convolve()</a>, <a class="el" href="_depth_to_space_8cpp_source.xhtml#l00018">armnn::DepthToSpace()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00015">armnn::GetOffset()</a>, <a class="el" href="_space_to_batch_nd_layer_8cpp_source.xhtml#l00042">SpaceToBatchNdLayer::InferOutputShapes()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.xhtml#l00039">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.xhtml#l00038">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_batch_to_space_nd_layer_8cpp_source.xhtml#l00057">BatchToSpaceNdLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.xhtml#l00018">armnn::InstanceNorm()</a>, <a class="el" href="backends_2reference_2workloads_2_batch_to_space_n_d_8cpp_source.xhtml#l00019">armnn::Offset()</a>, <a class="el" href="_tf_parser_8cpp_source.xhtml#l02463">armnnTfParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_pooling2d_8cpp_source.xhtml#l00143">armnn::Pooling2d()</a>, <a class="el" href="_resize_8cpp_source.xhtml#l00035">armnn::Resize()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.xhtml#l00029">Convolution2dLayer::SerializeLayerParameters()</a>, <a class="el" href="backends_2reference_2workloads_2_space_to_batch_n_d_8cpp_source.xhtml#l00034">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.xhtml#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.xhtml#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01603">SpaceToBatchNdQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.xhtml#l01669">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.xhtml#l03005">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
335<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{ <span class="keywordflow">return</span> m_WidthIndex; }</div></div><!-- fragment -->
336</div>
337</div>
338<hr/>The documentation for this class was generated from the following files:<ul>
339<li>include/armnnUtils/<a class="el" href="_data_layout_indexed_8hpp_source.xhtml">DataLayoutIndexed.hpp</a></li>
340<li>src/armnnUtils/<a class="el" href="_data_layout_indexed_8cpp_source.xhtml">DataLayoutIndexed.cpp</a></li>
341</ul>
342</div><!-- contents -->
343</div><!-- doc-content -->
344<!-- start footer part -->
345<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
346 <ul>
347 <li class="navelem"><a class="el" href="namespacearmnn_utils.xhtml">armnnUtils</a></li><li class="navelem"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.xhtml">DataLayoutIndexed</a></li>
348 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
349 <a href="http://www.doxygen.org/index.html">
350 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
351 </ul>
352</div>
353</body>
354</html>