blob: 1a8336eadb7f135045e136c333abe308e6d10e11 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.17-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arm NN: DataLayoutIndexed Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
<td id="projectalign" style="padding-left: 0.9em;">
<div id="projectname">
&#160;<span id="projectnumber">24.02</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarmnn_utils_1_1_data_layout_indexed.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classarmnn_utils_1_1_data_layout_indexed-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DataLayoutIndexed Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout.
<a href="classarmnn_utils_1_1_data_layout_indexed.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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.html#ac9468c3774c559c52844025b8bbb5a97">DataLayoutIndexed</a> (<a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a> dataLayout)</td></tr>
<tr class="separator:ac9468c3774c559c52844025b8bbb5a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d8b3d755b6ca8f5533657969efb06c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.html#a7d8b3d755b6ca8f5533657969efb06c4">GetDataLayout</a> () const</td></tr>
<tr class="separator:a7d8b3d755b6ca8f5533657969efb06c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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.html#a861b2621ee46e4b63379988b360b8cd9">GetChannelsIndex</a> () const</td></tr>
<tr class="separator:a861b2621ee46e4b63379988b360b8cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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.html#a61c00316c443adc233c24e85c6c5b740">GetHeightIndex</a> () const</td></tr>
<tr class="separator:a61c00316c443adc233c24e85c6c5b740"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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.html#a414e6f95548e6f7a01d5028b55ad3941">GetWidthIndex</a> () const</td></tr>
<tr class="separator:a414e6f95548e6f7a01d5028b55ad3941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45687cf74c4aeeacc6605a1f7ffe582a"><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.html#a45687cf74c4aeeacc6605a1f7ffe582a">GetDepthIndex</a> () const</td></tr>
<tr class="separator:a45687cf74c4aeeacc6605a1f7ffe582a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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.html#a1e25d8623da985a43597b5756c73b206">GetIndex</a> (const <a class="el" href="classarmnn_1_1_tensor_shape.html">armnn::TensorShape</a> &amp;shape, unsigned int batchIndex, unsigned int channelIndex, unsigned int heightIndex, unsigned int widthIndex) const</td></tr>
<tr class="separator:a1e25d8623da985a43597b5756c73b206"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout. </p>
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00017">17</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac9468c3774c559c52844025b8bbb5a97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9468c3774c559c52844025b8bbb5a97">&#9670;&nbsp;</a></span>DataLayoutIndexed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.html">DataLayoutIndexed</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a>&#160;</td>
<td class="paramname"><em>dataLayout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8cpp_source.html#l00013">13</a> of file <a class="el" href="_data_layout_indexed_8cpp_source.html">DataLayoutIndexed.cpp</a>.</p>
<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.html#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.html#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">case</span> <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a4dd0194b114cbf51da5b3a72569863ef">armnn::DataLayout::NDHWC</a>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; m_DepthIndex = 1;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; m_HeightIndex = 2;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; m_WidthIndex = 3;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; m_ChannelsIndex = 4;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a884e0167ebf9bbe6cfd6ca5ab97ab015">armnn::DataLayout::NCDHW</a>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; m_ChannelsIndex = 1;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; m_DepthIndex = 2;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; m_HeightIndex = 3;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; m_WidthIndex = 4;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(<span class="stringliteral">&quot;Unknown DataLayout value: &quot;</span> +</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; std::to_string(<span class="keyword">static_cast&lt;</span><span class="keywordtype">int</span><span class="keyword">&gt;</span>(dataLayout)));</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a884e0167ebf9bbe6cfd6ca5ab97ab015">armnn::NCDHW</a>, <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::NCHW</a>, <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a4dd0194b114cbf51da5b3a72569863ef">armnn::NDHWC</a>, and <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::NHWC</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a861b2621ee46e4b63379988b360b8cd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a861b2621ee46e4b63379988b360b8cd9">&#9670;&nbsp;</a></span>GetChannelsIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetChannelsIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00023">23</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<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 -->
<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00050">armnn::BatchToSpaceNd()</a>, <a class="el" href="_workload_utils_8cpp_source.html#l00207">armnn::Convert1HWOtoMIHW()</a>, <a class="el" href="_conv_impl_8cpp_source.html#l00071">armnn::Convolve()</a>, <a class="el" href="_conv3d_impl_8cpp_source.html#l00011">armnn::Convolve3d()</a>, <a class="el" href="_depth_to_space_8cpp_source.html#l00018">armnn::DepthToSpace()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00015">armnn::GetOffset()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.html#l00041">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_resize_layer_8cpp_source.html#l00039">ResizeLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.html#l00040">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_pooling3d_layer_8cpp_source.html#l00040">Pooling3dLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.html#l00018">armnn::InstanceNorm()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00015">armnn::Offset()</a>, <a class="el" href="_pooling2d_8cpp_source.html#l00142">armnn::Pooling2d()</a>, <a class="el" href="_pooling3d_8cpp_source.html#l00172">armnn::Pooling3d()</a>, <a class="el" href="_resize_8cpp_source.html#l00065">armnn::Resize()</a>, <a class="el" href="_fuse_batch_norm_8hpp_source.html#l00027">FuseBatchNorm&lt; ConvLayer, ArmnnType, T &gt;::Run()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00048">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.html#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.html#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_fold_pad_into_layer2d_8hpp_source.html#l00088">armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01575">ResizeQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01934">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.html#l03685">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
</div>
</div>
<a id="a7d8b3d755b6ca8f5533657969efb06c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d8b3d755b6ca8f5533657969efb06c4">&#9670;&nbsp;</a></span>GetDataLayout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a> GetDataLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00022">22</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<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 -->
<p class="reference">Referenced by <a class="el" href="_conv_impl_8cpp_source.html#l00071">armnn::Convolve()</a>, <a class="el" href="_conv3d_impl_8cpp_source.html#l00011">armnn::Convolve3d()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00015">armnn::GetOffset()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00015">armnn::Offset()</a>, <a class="el" href="_data_layout_indexed_8cpp_source.html#l00046">armnnUtils::operator==()</a>, and <a class="el" href="_pooling2d_8cpp_source.html#l00142">armnn::Pooling2d()</a>.</p>
</div>
</div>
<a id="a45687cf74c4aeeacc6605a1f7ffe582a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45687cf74c4aeeacc6605a1f7ffe582a">&#9670;&nbsp;</a></span>GetDepthIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetDepthIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00026">26</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{ <span class="keywordflow">return</span> m_DepthIndex; }</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_conv3d_impl_8cpp_source.html#l00011">armnn::Convolve3d()</a>, <a class="el" href="_pooling3d_layer_8cpp_source.html#l00040">Pooling3dLayer::InferOutputShapes()</a>, <a class="el" href="_convolution3d_layer_8cpp_source.html#l00062">Convolution3dLayer::InferOutputShapes()</a>, and <a class="el" href="_pooling3d_8cpp_source.html#l00172">armnn::Pooling3d()</a>.</p>
</div>
</div>
<a id="a61c00316c443adc233c24e85c6c5b740"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61c00316c443adc233c24e85c6c5b740">&#9670;&nbsp;</a></span>GetHeightIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetHeightIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00024">24</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<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 -->
<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00050">armnn::BatchToSpaceNd()</a>, <a class="el" href="_conversion_utils_8cpp_source.html#l00392">armnn_driver::ConvertPooling2d()</a>, <a class="el" href="_conv_impl_8cpp_source.html#l00071">armnn::Convolve()</a>, <a class="el" href="_conv3d_impl_8cpp_source.html#l00011">armnn::Convolve3d()</a>, <a class="el" href="_depth_to_space_8cpp_source.html#l00018">armnn::DepthToSpace()</a>, <a class="el" href="_fold_pad_into_layer2d_8hpp_source.html#l00144">armnn::optimizations::pad_fold::FoldPadIntoLayer2dImpl()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00015">armnn::GetOffset()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.html#l00041">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_pooling3d_layer_8cpp_source.html#l00040">Pooling3dLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.html#l00040">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_convolution3d_layer_8cpp_source.html#l00062">Convolution3dLayer::InferOutputShapes()</a>, <a class="el" href="_depthwise_convolution2d_layer_8cpp_source.html#l00065">DepthwiseConvolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.html#l00064">Convolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_transpose_convolution2d_layer_8cpp_source.html#l00057">TransposeConvolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.html#l00018">armnn::InstanceNorm()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00015">armnn::Offset()</a>, <a class="el" href="_pooling2d_8cpp_source.html#l00142">armnn::Pooling2d()</a>, <a class="el" href="_pooling3d_8cpp_source.html#l00172">armnn::Pooling3d()</a>, <a class="el" href="_resize_8cpp_source.html#l00065">armnn::Resize()</a>, <a class="el" href="_fuse_batch_norm_8hpp_source.html#l00027">FuseBatchNorm&lt; ConvLayer, ArmnnType, T &gt;::Run()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.html#l00029">Convolution2dLayer::SerializeLayerParameters()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00048">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.html#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.html#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_fold_pad_into_layer2d_8hpp_source.html#l00088">armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01848">SpaceToBatchNdQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01934">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.html#l03685">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
</div>
</div>
<a id="a1e25d8623da985a43597b5756c73b206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e25d8623da985a43597b5756c73b206">&#9670;&nbsp;</a></span>GetIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarmnn_1_1_tensor_shape.html">armnn::TensorShape</a> &amp;&#160;</td>
<td class="paramname"><em>shape</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>batchIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>channelIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>heightIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>widthIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset the given indices appropriately depending on the data layout</p>
<p>channelIndex stays unchanged</p>
<p>widthIndex stays unchanged</p>
<p>Get the value using the correct offset</p>
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00028">28</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<div class="fragment"><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; <span class="keywordflow">if</span> (batchIndex &gt;= shape[0] &amp;&amp; !( shape[0] == 0 &amp;&amp; batchIndex == 0))</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;Unable to get batch index&quot;</span>, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">if</span> (channelIndex &gt;= shape[m_ChannelsIndex] &amp;&amp;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; !(shape[m_ChannelsIndex] == 0 &amp;&amp; channelIndex == 0))</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;Unable to get channel index&quot;</span>, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </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">if</span> (heightIndex &gt;= shape[m_HeightIndex] &amp;&amp;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; !( shape[m_HeightIndex] == 0 &amp;&amp; heightIndex == 0))</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;Unable to get height index&quot;</span>, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> (widthIndex &gt;= shape[m_WidthIndex] &amp;&amp;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; ( shape[m_WidthIndex] == 0 &amp;&amp; widthIndex == 0))</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;Unable to get width index&quot;</span>, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> /// Offset the given indices appropriately depending on the data layout</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"></span> <span class="keywordflow">switch</span> (m_DataLayout)</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="keywordflow">case</span> <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; batchIndex *= shape[1] * shape[2] * shape[3]; <span class="comment">// batchIndex *= heightIndex * widthIndex * channelIndex</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; heightIndex *= shape[m_WidthIndex] * shape[m_ChannelsIndex];</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; widthIndex *= shape[m_ChannelsIndex];<span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> /// channelIndex stays unchanged</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"></span> <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; batchIndex *= shape[1] * shape[2] * shape[3]; <span class="comment">// batchIndex *= heightIndex * widthIndex * channelIndex</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; channelIndex *= shape[m_HeightIndex] * shape[m_WidthIndex];</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; heightIndex *= shape[m_WidthIndex];<span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> /// widthIndex stays unchanged</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"></span> <span class="keywordflow">break</span>;</div>
<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="comment"></span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> /// Get the value using the correct offset</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span> <span class="keywordflow">return</span> batchIndex + channelIndex + heightIndex + widthIndex;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00203">CHECK_LOCATION</a>, <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::NCHW</a>, and <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::NHWC</a>.</p>
<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_tensor_buffer_array_view_8hpp_source.html#l00031">TensorBufferArrayView&lt; DataType &gt;::Get()</a>, <a class="el" href="_instance_norm_8cpp_source.html#l00018">armnn::InstanceNorm()</a>, <a class="el" href="_resize_8cpp_source.html#l00065">armnn::Resize()</a>, and <a class="el" href="_transpose_convolution2d_8cpp_source.html#l00015">armnn::TransposeConvolution2dImpl()</a>.</p>
</div>
</div>
<a id="a414e6f95548e6f7a01d5028b55ad3941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a414e6f95548e6f7a01d5028b55ad3941">&#9670;&nbsp;</a></span>GetWidthIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetWidthIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_data_layout_indexed_8hpp_source.html#l00025">25</a> of file <a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a>.</p>
<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 -->
<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00050">armnn::BatchToSpaceNd()</a>, <a class="el" href="_conversion_utils_8cpp_source.html#l00392">armnn_driver::ConvertPooling2d()</a>, <a class="el" href="_conv_impl_8cpp_source.html#l00071">armnn::Convolve()</a>, <a class="el" href="_conv3d_impl_8cpp_source.html#l00011">armnn::Convolve3d()</a>, <a class="el" href="_depth_to_space_8cpp_source.html#l00018">armnn::DepthToSpace()</a>, <a class="el" href="_fold_pad_into_layer2d_8hpp_source.html#l00144">armnn::optimizations::pad_fold::FoldPadIntoLayer2dImpl()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00015">armnn::GetOffset()</a>, <a class="el" href="_depth_to_space_layer_8cpp_source.html#l00041">DepthToSpaceLayer::InferOutputShapes()</a>, <a class="el" href="_pooling3d_layer_8cpp_source.html#l00040">Pooling3dLayer::InferOutputShapes()</a>, <a class="el" href="_pooling2d_layer_8cpp_source.html#l00040">Pooling2dLayer::InferOutputShapes()</a>, <a class="el" href="_convolution3d_layer_8cpp_source.html#l00062">Convolution3dLayer::InferOutputShapes()</a>, <a class="el" href="_depthwise_convolution2d_layer_8cpp_source.html#l00065">DepthwiseConvolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.html#l00064">Convolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_transpose_convolution2d_layer_8cpp_source.html#l00057">TransposeConvolution2dLayer::InferOutputShapes()</a>, <a class="el" href="_instance_norm_8cpp_source.html#l00018">armnn::InstanceNorm()</a>, <a class="el" href="_batch_to_space_nd_8cpp_source.html#l00015">armnn::Offset()</a>, <a class="el" href="_pooling2d_8cpp_source.html#l00142">armnn::Pooling2d()</a>, <a class="el" href="_pooling3d_8cpp_source.html#l00172">armnn::Pooling3d()</a>, <a class="el" href="_resize_8cpp_source.html#l00065">armnn::Resize()</a>, <a class="el" href="_fuse_batch_norm_8hpp_source.html#l00027">FuseBatchNorm&lt; ConvLayer, ArmnnType, T &gt;::Run()</a>, <a class="el" href="_convolution2d_layer_8cpp_source.html#l00029">Convolution2dLayer::SerializeLayerParameters()</a>, <a class="el" href="_space_to_batch_nd_8cpp_source.html#l00048">armnn::SpaceToBatchNd()</a>, <a class="el" href="_space_to_depth_8cpp_source.html#l00036">armnn::SpaceToDepth()</a>, <a class="el" href="_transpose_convolution2d_8cpp_source.html#l00015">armnn::TransposeConvolution2dImpl()</a>, <a class="el" href="_fold_pad_into_layer2d_8hpp_source.html#l00088">armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01848">SpaceToBatchNdQueueDescriptor::Validate()</a>, <a class="el" href="_workload_data_8cpp_source.html#l01934">SpaceToDepthQueueDescriptor::Validate()</a>, and <a class="el" href="_workload_data_8cpp_source.html#l03685">DepthToSpaceQueueDescriptor::Validate()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/armnnUtils/<a class="el" href="_data_layout_indexed_8hpp_source.html">DataLayoutIndexed.hpp</a></li>
<li>src/armnnUtils/<a class="el" href="_data_layout_indexed_8cpp_source.html">DataLayoutIndexed.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a884e0167ebf9bbe6cfd6ca5ab97ab015"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a884e0167ebf9bbe6cfd6ca5ab97ab015">armnn::DataLayout::NCDHW</a></div><div class="ttdeci">@ NCDHW</div></div>
<div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0ad066db54b89b0912e7e7c6da51e2da51">armnn::DataLayout::NHWC</a></div><div class="ttdeci">@ NHWC</div></div>
<div class="ttc" id="a_exceptions_8hpp_html_aa3be76aec4ce713822a5ea1ecbb7bc61"><div class="ttname"><a href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a></div><div class="ttdeci">#define CHECK_LOCATION()</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00203">Exceptions.hpp:203</a></div></div>
<div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a4dd0194b114cbf51da5b3a72569863ef"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a4dd0194b114cbf51da5b3a72569863ef">armnn::DataLayout::NDHWC</a></div><div class="ttdeci">@ NDHWC</div></div>
<div class="ttc" id="aclassarmnn_1_1_invalid_argument_exception_html"><div class="ttname"><a href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00080">Exceptions.hpp:80</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_exception_html"><div class="ttname"><a href="classarmnn_1_1_exception.html">armnn::Exception</a></div><div class="ttdoc">Base class for all ArmNN exceptions so that users can filter to just those.</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00046">Exceptions.hpp:46</a></div></div>
<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>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacearmnn_utils.html">armnnUtils</a></li><li class="navelem"><a class="el" href="classarmnn_utils_1_1_data_layout_indexed.html">DataLayoutIndexed</a></li>
<li class="footer">Generated on Wed Feb 14 2024 16:36:26 for Arm NN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>