blob: 037883832b5f101b4ef704bbd61dfb04ac76d8f0 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- 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/RefWorkloadUtils.hpp File Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<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 &#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
50var 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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('_ref_workload_utils_8hpp.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="summary">
96<a href="#namespaces">Namespaces</a> &#124;
97<a href="#define-members">Macros</a> &#124;
98<a href="#func-members">Functions</a> </div>
99 <div class="headertitle">
100<div class="title">RefWorkloadUtils.hpp File Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103<div class="textblock"><code>#include &lt;<a class="el" href="_tensor_handle_8hpp_source.html">armnn/backends/TensorHandle.hpp</a>&gt;</code><br />
104<code>#include &lt;<a class="el" href="_tensor_8hpp_source.html">armnn/Tensor.hpp</a>&gt;</code><br />
105<code>#include &lt;<a class="el" href="_types_8hpp_source.html">armnn/Types.hpp</a>&gt;</code><br />
106<code>#include &lt;<a class="el" href="_polymorphic_downcast_8hpp_source.html">armnn/utility/PolymorphicDowncast.hpp</a>&gt;</code><br />
107<code>#include &lt;<a class="el" href="_ref_tensor_handle_8hpp_source.html">reference/RefTensorHandle.hpp</a>&gt;</code><br />
108<code>#include &lt;<a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>&gt;</code><br />
109<code>#include &lt;<a class="el" href="_half_8hpp_source.html">Half.hpp</a>&gt;</code><br />
110</div><div class="textblock"><div class="dynheader">
111Include dependency graph for RefWorkloadUtils.hpp:</div>
112<div class="dyncontent">
113<div class="center"><iframe scrolling="no" frameborder="0" src="_ref_workload_utils_8hpp__incl.svg" width="1999" height="590"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
114</div>
115</div>
116</div><div class="textblock"><div class="dynheader">
117This graph shows which files directly or indirectly include this file:</div>
118<div class="dyncontent">
119<div class="center"><iframe scrolling="no" frameborder="0" src="_ref_workload_utils_8hpp__dep__incl.svg" width="18906" height="350"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
120</div>
121</div>
122</div>
123<p><a href="_ref_workload_utils_8hpp_source.html">Go to the source code of this file.</a></p>
124<table class="memberdecls">
125<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
126Namespaces</h2></td></tr>
127<tr class="memitem:namespacearmnn"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn.html">armnn</a></td></tr>
128<tr class="memdesc:namespacearmnn"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2021 ARM Limited and Contributors. <br /></td></tr>
129<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
130</table><table class="memberdecls">
131<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
132Macros</h2></td></tr>
133<tr class="memitem:a06acca4fd832e0fb179604112c0505af"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_ref_workload_utils_8hpp.html#a06acca4fd832e0fb179604112c0505af">ARMNN_SCOPED_PROFILING_EVENT_REF_NAME_GUID</a>(label)</td></tr>
134<tr class="memdesc:a06acca4fd832e0fb179604112c0505af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a profiling event that uses GetGuid() and GetName() from the calling class. <a href="_ref_workload_utils_8hpp.html#a06acca4fd832e0fb179604112c0505af">More...</a><br /></td></tr>
135<tr class="separator:a06acca4fd832e0fb179604112c0505af"><td class="memSeparator" colspan="2">&#160;</td></tr>
136</table><table class="memberdecls">
137<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
138Functions</h2></td></tr>
139<tr class="memitem:aa815fde54f6d8e8aa5b4f0301cf4178b"><td class="memTemplParams" colspan="2">template&lt;typename TensorHandleType = RefTensorHandle&gt; </td></tr>
140<tr class="memitem:aa815fde54f6d8e8aa5b4f0301cf4178b"><td class="memTemplItemLeft" align="right" valign="top">const TensorInfo &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#aa815fde54f6d8e8aa5b4f0301cf4178b">GetTensorInfo</a> (const ITensorHandle *tensorHandle)</td></tr>
141<tr class="memdesc:aa815fde54f6d8e8aa5b4f0301cf4178b"><td class="mdescLeft">&#160;</td><td class="mdescRight">float32 helpers <a href="namespacearmnn.html#aa815fde54f6d8e8aa5b4f0301cf4178b">More...</a><br /></td></tr>
142<tr class="separator:aa815fde54f6d8e8aa5b4f0301cf4178b"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:a2187ea15b1ae8c323a0cc5c211fc43d9"><td class="memTemplParams" colspan="2">template&lt;typename DataType , typename PayloadType &gt; </td></tr>
144<tr class="memitem:a2187ea15b1ae8c323a0cc5c211fc43d9"><td class="memTemplItemLeft" align="right" valign="top">const DataType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a2187ea15b1ae8c323a0cc5c211fc43d9">GetInputTensorData</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
145<tr class="separator:a2187ea15b1ae8c323a0cc5c211fc43d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:ae9f37e0b5f15afd89a29788a319da9ec"><td class="memTemplParams" colspan="2">template&lt;typename DataType , typename PayloadType &gt; </td></tr>
147<tr class="memitem:ae9f37e0b5f15afd89a29788a319da9ec"><td class="memTemplItemLeft" align="right" valign="top">DataType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#ae9f37e0b5f15afd89a29788a319da9ec">GetOutputTensorData</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
148<tr class="separator:ae9f37e0b5f15afd89a29788a319da9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a5442d22144b3608bcfc7eea1bc55e35d"><td class="memTemplParams" colspan="2">template&lt;typename DataType &gt; </td></tr>
150<tr class="memitem:a5442d22144b3608bcfc7eea1bc55e35d"><td class="memTemplItemLeft" align="right" valign="top">DataType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a5442d22144b3608bcfc7eea1bc55e35d">GetOutputTensorData</a> (ITensorHandle *tensorHandle)</td></tr>
151<tr class="separator:a5442d22144b3608bcfc7eea1bc55e35d"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a691846a9eee59b0cd5b22fb5f674e007"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
153<tr class="memitem:a691846a9eee59b0cd5b22fb5f674e007"><td class="memTemplItemLeft" align="right" valign="top">const float *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a691846a9eee59b0cd5b22fb5f674e007">GetInputTensorDataFloat</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
154<tr class="separator:a691846a9eee59b0cd5b22fb5f674e007"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:ab5f0afc1e37fd100843ecd55d8f284c1"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
156<tr class="memitem:ab5f0afc1e37fd100843ecd55d8f284c1"><td class="memTemplItemLeft" align="right" valign="top">float *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#ab5f0afc1e37fd100843ecd55d8f284c1">GetOutputTensorDataFloat</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
157<tr class="separator:ab5f0afc1e37fd100843ecd55d8f284c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a084b0ce273bef78aa314bd97fc574b84"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
159<tr class="memitem:a084b0ce273bef78aa314bd97fc574b84"><td class="memTemplItemLeft" align="right" valign="top">const Half *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a084b0ce273bef78aa314bd97fc574b84">GetInputTensorDataHalf</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
160<tr class="separator:a084b0ce273bef78aa314bd97fc574b84"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:ab98e77207c3d676b0b9ffa67357dbc6a"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
162<tr class="memitem:ab98e77207c3d676b0b9ffa67357dbc6a"><td class="memTemplItemLeft" align="right" valign="top">Half *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#ab98e77207c3d676b0b9ffa67357dbc6a">GetOutputTensorDataHalf</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
163<tr class="separator:ab98e77207c3d676b0b9ffa67357dbc6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:ac44cb4d413a43342b120b2c4d047d648"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
165<tr class="memitem:ac44cb4d413a43342b120b2c4d047d648"><td class="memTemplItemLeft" align="right" valign="top">const BFloat16 *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#ac44cb4d413a43342b120b2c4d047d648">GetInputTensorDataBFloat16</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
166<tr class="separator:ac44cb4d413a43342b120b2c4d047d648"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:a85ace5e5f41a093622a8c04150d24c60"><td class="memTemplParams" colspan="2">template&lt;typename PayloadType &gt; </td></tr>
168<tr class="memitem:a85ace5e5f41a093622a8c04150d24c60"><td class="memTemplItemLeft" align="right" valign="top">BFloat16 *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a85ace5e5f41a093622a8c04150d24c60">GetOutputTensorDataBFloat16</a> (unsigned int idx, const PayloadType &amp;data)</td></tr>
169<tr class="separator:a85ace5e5f41a093622a8c04150d24c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a4144d7535639c617fca0d095379493f0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
171<tr class="memitem:a4144d7535639c617fca0d095379493f0"><td class="memTemplItemLeft" align="right" valign="top">std::vector&lt; float &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a4144d7535639c617fca0d095379493f0">Dequantize</a> (const T *quant, const TensorInfo &amp;info)</td></tr>
172<tr class="memdesc:a4144d7535639c617fca0d095379493f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">u8 helpers <a href="namespacearmnn.html#a4144d7535639c617fca0d095379493f0">More...</a><br /></td></tr>
173<tr class="separator:a4144d7535639c617fca0d095379493f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<tr class="memitem:a1204727d8ce3ee1e60daf08079eb892e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
175<tr class="memitem:a1204727d8ce3ee1e60daf08079eb892e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#a1204727d8ce3ee1e60daf08079eb892e">Dequantize</a> (const T *inputData, float *outputData, const TensorInfo &amp;info)</td></tr>
176<tr class="separator:a1204727d8ce3ee1e60daf08079eb892e"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<tr class="memitem:abbbe4a59b72fba606f21e7c24dcbd8c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn.html#abbbe4a59b72fba606f21e7c24dcbd8c0">Quantize</a> (uint8_t *quant, const float *dequant, const TensorInfo &amp;info)</td></tr>
178<tr class="separator:abbbe4a59b72fba606f21e7c24dcbd8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
179</table>
180<h2 class="groupheader">Macro Definition Documentation</h2>
181<a id="a06acca4fd832e0fb179604112c0505af"></a>
182<h2 class="memtitle"><span class="permalink"><a href="#a06acca4fd832e0fb179604112c0505af">&#9670;&nbsp;</a></span>ARMNN_SCOPED_PROFILING_EVENT_REF_NAME_GUID</h2>
183
184<div class="memitem">
185<div class="memproto">
186 <table class="memname">
187 <tr>
188 <td class="memname">#define ARMNN_SCOPED_PROFILING_EVENT_REF_NAME_GUID</td>
189 <td>(</td>
190 <td class="paramtype">&#160;</td>
191 <td class="paramname">label</td><td>)</td>
192 <td></td>
193 </tr>
194 </table>
195</div><div class="memdoc">
196<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="_profiling_8hpp.html#a1d6c14f3b73fa7a440ebaf53afa53266">ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS</a>(<a class="code" href="namespacearmnn.html#ae2f04a162585c0a5222a537efd5456aea83c2c4e9b658ccafbcbe6309c5d84c64">armnn::Compute::CpuRef</a>, \</div>
197<div class="line"> this-&gt;GetGuid(), \</div>
198<div class="line"> this-&gt;GetName() + <span class="stringliteral">&quot;_&quot;</span> + label, \</div>
199<div class="line"> <a class="code" href="classarmnn_1_1_wall_clock_timer.html">armnn::WallClockTimer</a>())</div>
200</div><!-- fragment -->
201<p>Creates a profiling event that uses GetGuid() and GetName() from the calling class. </p>
202
203<p class="definition">Definition at line <a class="el" href="_ref_workload_utils_8hpp_source.html#l00022">22</a> of file <a class="el" href="_ref_workload_utils_8hpp_source.html">RefWorkloadUtils.hpp</a>.</p>
204
205</div>
206</div>
207</div><!-- contents -->
208</div><!-- doc-content -->
209<div class="ttc" id="a_profiling_8hpp_html_a1d6c14f3b73fa7a440ebaf53afa53266"><div class="ttname"><a href="_profiling_8hpp.html#a1d6c14f3b73fa7a440ebaf53afa53266">ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS</a></div><div class="ttdeci">#define ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(backendId, guid,...)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8hpp_source.html#l00217">Profiling.hpp:217</a></div></div>
210<div class="ttc" id="anamespacearmnn_html_ae2f04a162585c0a5222a537efd5456aea83c2c4e9b658ccafbcbe6309c5d84c64"><div class="ttname"><a href="namespacearmnn.html#ae2f04a162585c0a5222a537efd5456aea83c2c4e9b658ccafbcbe6309c5d84c64">armnn::Compute::CpuRef</a></div><div class="ttdeci">@ CpuRef</div><div class="ttdoc">CPU Execution: Reference C++ kernels.</div></div>
211<div class="ttc" id="aclassarmnn_1_1_wall_clock_timer_html"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html">armnn::WallClockTimer</a></div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00038">WallClockTimer.hpp:38</a></div></div>
212<!-- start footer part -->
213<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
214 <ul>
215 <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="_ref_workload_utils_8hpp.html">RefWorkloadUtils.hpp</a></li>
216 <li class="footer">Generated on Thu May 16 2024 09:31:53 for Arm NN by
217 <a href="http://www.doxygen.org/index.html">
218 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
219 </ul>
220</div>
221</body>
222</html>