1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: utils/Utils.h 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 <script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25 $(document).ready(function() { init_search(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.02</span>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
61 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
80 <div id="navrow2" class="tabs2">
82 <li><a href="files.xhtml"><span>File List</span></a></li>
83 <li><a href="globals.xhtml"><span>Globals</span></a></li>
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('utils_2_utils_8h.xhtml','');});
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
116 <div class="summary">
117 <a href="#nested-classes">Data Structures</a> |
118 <a href="#namespaces">Namespaces</a> |
119 <a href="#func-members">Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">Utils.h File Reference</div> </div>
123 <div class="contents">
124 <div class="textblock"><code>#include "<a class="el" href="arm__compute_2core_2_helpers_8h_source.xhtml">arm_compute/core/Helpers.h</a>"</code><br />
125 <code>#include "<a class="el" href="_i_tensor_8h_source.xhtml">arm_compute/core/ITensor.h</a>"</code><br />
126 <code>#include "<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">arm_compute/core/Types.h</a>"</code><br />
127 <code>#include "<a class="el" href="_validate_8h_source.xhtml">arm_compute/core/Validate.h</a>"</code><br />
128 <code>#include "<a class="el" href="_window_8h_source.xhtml">arm_compute/core/Window.h</a>"</code><br />
129 <code>#include "<a class="el" href="runtime_2_tensor_8h_source.xhtml">arm_compute/runtime/Tensor.h</a>"</code><br />
130 <code>#include "libnpy/npy.hpp"</code><br />
131 <code>#include "<a class="el" href="_toolchain_support_8h_source.xhtml">support/ToolchainSupport.h</a>"</code><br />
132 <code>#include <cstdlib></code><br />
133 <code>#include <cstring></code><br />
134 <code>#include <fstream></code><br />
135 <code>#include <iostream></code><br />
136 <code>#include <random></code><br />
137 <code>#include <string></code><br />
138 <code>#include <tuple></code><br />
139 <code>#include <vector></code><br />
141 <p><a href="utils_2_utils_8h_source.xhtml">Go to the source code of this file.</a></p>
142 <table class="memberdecls">
143 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
144 Data Structures</h2></td></tr>
145 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml">Example</a></td></tr>
146 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract <a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml" title="Abstract Example class. ">Example</a> class. <a href="classarm__compute_1_1utils_1_1_example.xhtml#details">More...</a><br /></td></tr>
147 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml">PPMLoader</a></td></tr>
149 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to load the content of a PPM file into an <a class="el" href="struct_image.xhtml" title="Structure to hold Image information. ">Image</a>. <a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#details">More...</a><br /></td></tr>
150 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
151 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_n_p_y_loader.xhtml">NPYLoader</a></td></tr>
152 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
153 </table><table class="memberdecls">
154 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
155 Namespaces</h2></td></tr>
156 <tr class="memitem:namespacearm__compute"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></td></tr>
157 <tr class="memdesc:namespacearm__compute"><td class="mdescLeft"> </td><td class="mdescRight">This file contains all available output stages for GEMMLowp on OpenCL. <br /></td></tr>
158 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:namespacearm__compute_1_1utils"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml">arm_compute::utils</a></td></tr>
160 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
161 </table><table class="memberdecls">
162 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
163 Functions</h2></td></tr>
164 <tr class="memitem:a8c0c1084048e5b60a60d7ea85fd9a96a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a8c0c1084048e5b60a60d7ea85fd9a96a">run_example</a> (int argc, char **argv, Example &example)</td></tr>
165 <tr class="memdesc:a8c0c1084048e5b60a60d7ea85fd9a96a"><td class="mdescLeft"> </td><td class="mdescRight">Run an example and handle the potential exceptions it throws. <a href="namespacearm__compute_1_1utils.xhtml#a8c0c1084048e5b60a60d7ea85fd9a96a">More...</a><br /></td></tr>
166 <tr class="separator:a8c0c1084048e5b60a60d7ea85fd9a96a"><td class="memSeparator" colspan="2"> </td></tr>
167 <tr class="memitem:ac6126fda74b244d4c9a75328a3f436a3"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
168 <tr class="memitem:ac6126fda74b244d4c9a75328a3f436a3"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#ac6126fda74b244d4c9a75328a3f436a3">run_example</a> (int argc, char **argv)</td></tr>
169 <tr class="separator:ac6126fda74b244d4c9a75328a3f436a3"><td class="memSeparator" colspan="2"> </td></tr>
170 <tr class="memitem:ad1b5373f466a3945e1f0ef1c9943c357"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#ad1b5373f466a3945e1f0ef1c9943c357">draw_detection_rectangle</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">arm_compute::ITensor</a> *tensor, const <a class="el" href="structarm__compute_1_1_detection_window.xhtml">arm_compute::DetectionWindow</a> &rect, uint8_t r, uint8_t g, uint8_t b)</td></tr>
171 <tr class="memdesc:ad1b5373f466a3945e1f0ef1c9943c357"><td class="mdescLeft"> </td><td class="mdescRight">Draw a RGB rectangular window for the detected object. <a href="namespacearm__compute_1_1utils.xhtml#ad1b5373f466a3945e1f0ef1c9943c357">More...</a><br /></td></tr>
172 <tr class="separator:ad1b5373f466a3945e1f0ef1c9943c357"><td class="memSeparator" colspan="2"> </td></tr>
173 <tr class="memitem:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memItemLeft" align="right" valign="top">std::tuple< unsigned int, unsigned int, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a3aa8f5f1b94f88fdf5b43a53e29379cf">parse_ppm_header</a> (std::ifstream &fs)</td></tr>
174 <tr class="memdesc:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="mdescLeft"> </td><td class="mdescRight">Parse the ppm header from an input file stream. <a href="namespacearm__compute_1_1utils.xhtml#a3aa8f5f1b94f88fdf5b43a53e29379cf">More...</a><br /></td></tr>
175 <tr class="separator:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memSeparator" colspan="2"> </td></tr>
176 <tr class="memitem:acdab4f47904c52221c85cc80f408f183"><td class="memItemLeft" align="right" valign="top">std::tuple< std::vector< unsigned long >, bool, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#acdab4f47904c52221c85cc80f408f183">parse_npy_header</a> (std::ifstream &fs)</td></tr>
177 <tr class="memdesc:acdab4f47904c52221c85cc80f408f183"><td class="mdescLeft"> </td><td class="mdescRight">Parse the npy header from an input file stream. <a href="namespacearm__compute_1_1utils.xhtml#acdab4f47904c52221c85cc80f408f183">More...</a><br /></td></tr>
178 <tr class="separator:acdab4f47904c52221c85cc80f408f183"><td class="memSeparator" colspan="2"> </td></tr>
179 <tr class="memitem:a7990fd2b875e2f6d4c1eded54539cb19"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a7990fd2b875e2f6d4c1eded54539cb19">get_typestring</a> (DataType data_type)</td></tr>
180 <tr class="memdesc:a7990fd2b875e2f6d4c1eded54539cb19"><td class="mdescLeft"> </td><td class="mdescRight">Obtain numpy type string from DataType. <a href="namespacearm__compute_1_1utils.xhtml#a7990fd2b875e2f6d4c1eded54539cb19">More...</a><br /></td></tr>
181 <tr class="separator:a7990fd2b875e2f6d4c1eded54539cb19"><td class="memSeparator" colspan="2"> </td></tr>
182 <tr class="memitem:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
183 <tr class="memitem:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a9c3303817ba653b5d1e78efb88d02bcf">map</a> (T &tensor, bool blocking)</td></tr>
184 <tr class="memdesc:a9c3303817ba653b5d1e78efb88d02bcf"><td class="mdescLeft"> </td><td class="mdescRight">Maps a tensor if needed. <a href="namespacearm__compute_1_1utils.xhtml#a9c3303817ba653b5d1e78efb88d02bcf">More...</a><br /></td></tr>
185 <tr class="separator:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memSeparator" colspan="2"> </td></tr>
186 <tr class="memitem:a4ff2134cb88cb5a27120cddb98b59774"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
187 <tr class="memitem:a4ff2134cb88cb5a27120cddb98b59774"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a4ff2134cb88cb5a27120cddb98b59774">unmap</a> (T &tensor)</td></tr>
188 <tr class="memdesc:a4ff2134cb88cb5a27120cddb98b59774"><td class="mdescLeft"> </td><td class="mdescRight">Unmaps a tensor if needed. <a href="namespacearm__compute_1_1utils.xhtml#a4ff2134cb88cb5a27120cddb98b59774">More...</a><br /></td></tr>
189 <tr class="separator:a4ff2134cb88cb5a27120cddb98b59774"><td class="memSeparator" colspan="2"> </td></tr>
190 <tr class="memitem:a301d0b7bfd70f73fc1924f4281938d08"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
191 <tr class="memitem:a301d0b7bfd70f73fc1924f4281938d08"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">save_to_ppm</a> (T &tensor, const std::string &ppm_filename)</td></tr>
192 <tr class="memdesc:a301d0b7bfd70f73fc1924f4281938d08"><td class="mdescLeft"> </td><td class="mdescRight">Template helper function to save a tensor image to a PPM file. <a href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">More...</a><br /></td></tr>
193 <tr class="separator:a301d0b7bfd70f73fc1924f4281938d08"><td class="memSeparator" colspan="2"> </td></tr>
194 <tr class="memitem:a3f8c80e5ec379049ad0a9ba1d8ad5547"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
195 <tr class="memitem:a3f8c80e5ec379049ad0a9ba1d8ad5547"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a3f8c80e5ec379049ad0a9ba1d8ad5547">save_to_npy</a> (T &tensor, const std::string &npy_filename, bool fortran_order)</td></tr>
196 <tr class="memdesc:a3f8c80e5ec379049ad0a9ba1d8ad5547"><td class="mdescLeft"> </td><td class="mdescRight">Template helper function to save a tensor image to a NPY file. <a href="namespacearm__compute_1_1utils.xhtml#a3f8c80e5ec379049ad0a9ba1d8ad5547">More...</a><br /></td></tr>
197 <tr class="separator:a3f8c80e5ec379049ad0a9ba1d8ad5547"><td class="memSeparator" colspan="2"> </td></tr>
198 <tr class="memitem:af214346f90d640ac468dd90fa2a275cc"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
199 <tr class="memitem:af214346f90d640ac468dd90fa2a275cc"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#af214346f90d640ac468dd90fa2a275cc">load_trained_data</a> (T &tensor, const std::string &filename)</td></tr>
200 <tr class="memdesc:af214346f90d640ac468dd90fa2a275cc"><td class="mdescLeft"> </td><td class="mdescRight">Load the tensor with pre-trained data from a binary file. <a href="namespacearm__compute_1_1utils.xhtml#af214346f90d640ac468dd90fa2a275cc">More...</a><br /></td></tr>
201 <tr class="separator:af214346f90d640ac468dd90fa2a275cc"><td class="memSeparator" colspan="2"> </td></tr>
202 <tr class="memitem:abe777f4e6d2b0d9964eee32f5ae3fca7"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
203 <tr class="memitem:abe777f4e6d2b0d9964eee32f5ae3fca7"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#abe777f4e6d2b0d9964eee32f5ae3fca7">fill_random_tensor</a> (T &tensor, float lower_bound, float upper_bound)</td></tr>
204 <tr class="separator:abe777f4e6d2b0d9964eee32f5ae3fca7"><td class="memSeparator" colspan="2"> </td></tr>
205 <tr class="memitem:a3ff90da00700526d89a0ee29f85fd804"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
206 <tr class="memitem:a3ff90da00700526d89a0ee29f85fd804"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a3ff90da00700526d89a0ee29f85fd804">init_sgemm_output</a> (T &dst, T &src0, T &src1, <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">arm_compute::DataType</a> dt)</td></tr>
207 <tr class="separator:a3ff90da00700526d89a0ee29f85fd804"><td class="memSeparator" colspan="2"> </td></tr>
208 <tr class="memitem:afb7b08e5c044dba650037628089a4e7c"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#afb7b08e5c044dba650037628089a4e7c">get_mem_free_from_meminfo</a> ()</td></tr>
209 <tr class="memdesc:afb7b08e5c044dba650037628089a4e7c"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the amount of memory free reading from /proc/meminfo. <a href="namespacearm__compute_1_1utils.xhtml#afb7b08e5c044dba650037628089a4e7c">More...</a><br /></td></tr>
210 <tr class="separator:afb7b08e5c044dba650037628089a4e7c"><td class="memSeparator" colspan="2"> </td></tr>
212 </div><!-- contents -->
213 </div><!-- doc-content -->
214 <!-- start footer part -->
215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
217 <li class="navelem"><a class="el" href="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.xhtml">utils</a></li><li class="navelem"><a class="el" href="utils_2_utils_8h.xhtml">Utils.h</a></li>
218 <li class="footer">Generated on Thu Feb 22 2018 15:45:21 for Compute Library by
219 <a href="http://www.doxygen.org/index.html">
220 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>