blob: 8f13f0e6199e51bfe7f03ef6a19a2f7b0f38eddb [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +00001<!-- 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">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Kaizen8938bd32017-09-28 14:38:23 +01007<meta name="generator" content="Doxygen 1.8.6"/>
Anthony Barbier871448e2017-03-24 14:54:29 +00008<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +01009<title>Compute Library: utils/Utils.h File Reference</title>
Anthony Barbier871448e2017-03-24 14:54:29 +000010<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>
Anthony Barbier871448e2017-03-24 14:54:29 +000015<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000021<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
Kaizen8938bd32017-09-28 14:38:23 +010023 $(document).ready(function() { searchBox.OnSelectItem(0); });
Anthony Barbier871448e2017-03-24 14:54:29 +000024</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Kaizen8938bd32017-09-28 14:38:23 +010030</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000031<link href="doxygen.css" rel="stylesheet" type="text/css" />
32</head>
33<body>
34<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35<div id="titlearea">
36<table cellspacing="0" cellpadding="0">
37 <tbody>
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
Anthony Barbierdbdab852017-06-23 15:42:00 +010040 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +010041 &#160;<span id="projectnumber">17.10</span>
Anthony Barbier871448e2017-03-24 14:54:29 +000042 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
Kaizen8938bd32017-09-28 14:38:23 +010049<!-- Generated by Doxygen 1.8.6 -->
Anthony Barbier871448e2017-03-24 14:54:29 +000050<script type="text/javascript">
51var searchBox = new SearchBox("searchBox", "search",false,'Search');
52</script>
53 <div id="navrow1" class="tabs">
54 <ul class="tablist">
55 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
Anthony Barbierdbdab852017-06-23 15:42:00 +010056 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
Anthony Barbier871448e2017-03-24 14:54:29 +000057 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
60 <li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
62 <span class="left">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
66 alt=""/>
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73 </span>
74 </div>
75 </li>
76 </ul>
77 </div>
78 <div id="navrow2" class="tabs2">
79 <ul class="tablist">
80 <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
81 <li><a href="globals.xhtml"><span>Globals</span></a></li>
82 </ul>
83 </div>
84</div><!-- top -->
85<div id="side-nav" class="ui-resizable side-nav-resizable">
86 <div id="nav-tree">
87 <div id="nav-tree-contents">
88 <div id="nav-sync" class="sync"></div>
89 </div>
90 </div>
91 <div id="splitbar" style="-moz-user-select:none;"
92 class="ui-resizable-handle">
93 </div>
94</div>
95<script type="text/javascript">
Anthony Barbierdbdab852017-06-23 15:42:00 +010096$(document).ready(function(){initNavTree('utils_2_utils_8h.xhtml','');});
Anthony Barbier871448e2017-03-24 14:54:29 +000097</script>
98<div id="doc-content">
99<!-- window showing the filter options -->
100<div id="MSearchSelectWindow"
101 onmouseover="return searchBox.OnSearchSelectShow()"
102 onmouseout="return searchBox.OnSearchSelectHide()"
103 onkeydown="return searchBox.OnSearchSelectKey(event)">
Kaizen8938bd32017-09-28 14:38:23 +0100104<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000105
106<!-- iframe showing the search results (closed by default) -->
107<div id="MSearchResultsWindow">
108<iframe src="javascript:void(0)" frameborder="0"
109 name="MSearchResults" id="MSearchResults">
110</iframe>
111</div>
112
113<div class="header">
114 <div class="summary">
115<a href="#nested-classes">Data Structures</a> &#124;
116<a href="#namespaces">Namespaces</a> &#124;
117<a href="#typedef-members">Typedefs</a> &#124;
118<a href="#func-members">Functions</a> </div>
119 <div class="headertitle">
120<div class="title">Utils.h File Reference</div> </div>
121</div><!--header-->
122<div class="contents">
Kaizen8938bd32017-09-28 14:38:23 +0100123<div class="textblock"><code>#include &quot;<a class="el" href="arm__compute_2core_2_helpers_8h_source.xhtml">arm_compute/core/Helpers.h</a>&quot;</code><br/>
124<code>#include &quot;<a class="el" href="_i_tensor_8h_source.xhtml">arm_compute/core/ITensor.h</a>&quot;</code><br/>
125<code>#include &quot;<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">arm_compute/core/Types.h</a>&quot;</code><br/>
126<code>#include &quot;<a class="el" href="_validate_8h_source.xhtml">arm_compute/core/Validate.h</a>&quot;</code><br/>
127<code>#include &quot;<a class="el" href="_window_8h_source.xhtml">arm_compute/core/Window.h</a>&quot;</code><br/>
128<code>#include &quot;<a class="el" href="runtime_2_tensor_8h_source.xhtml">arm_compute/runtime/Tensor.h</a>&quot;</code><br/>
129<code>#include &quot;<a class="el" href="_toolchain_support_8h_source.xhtml">support/ToolchainSupport.h</a>&quot;</code><br/>
130<code>#include &lt;cstdlib&gt;</code><br/>
131<code>#include &lt;cstring&gt;</code><br/>
132<code>#include &lt;fstream&gt;</code><br/>
133<code>#include &lt;iostream&gt;</code><br/>
Anthony Barbier871448e2017-03-24 14:54:29 +0000134</div>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100135<p><a href="utils_2_utils_8h_source.xhtml">Go to the source code of this file.</a></p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000136<table class="memberdecls">
137<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
138Data Structures</h2></td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100139<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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>
Kaizen8938bd32017-09-28 14:38:23 +0100140<tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Anthony Barbier871448e2017-03-24 14:54:29 +0000141<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
142</table><table class="memberdecls">
143<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
144Namespaces</h2></td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100145<tr class="memitem:namespacearm__compute"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100146<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100147<tr class="memitem:namespacearm__compute_1_1utils"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml">arm_compute::utils</a></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000148<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
149</table><table class="memberdecls">
150<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
151Typedefs</h2></td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100152<tr class="memitem:a27e6364d61a5b27447d27337aa182cad"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a27e6364d61a5b27447d27337aa182cad">example</a> = void(int argc, const char **argv)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100153<tr class="memdesc:a27e6364d61a5b27447d27337aa182cad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signature of an example to run. <a href="#a27e6364d61a5b27447d27337aa182cad">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000154<tr class="separator:a27e6364d61a5b27447d27337aa182cad"><td class="memSeparator" colspan="2">&#160;</td></tr>
155</table><table class="memberdecls">
156<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
157Functions</h2></td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100158<tr class="memitem:a4c9395db2c8b8d0c336656a7b58fca3e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a4c9395db2c8b8d0c336656a7b58fca3e">run_example</a> (int argc, const char **argv, example &amp;func)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100159<tr class="memdesc:a4c9395db2c8b8d0c336656a7b58fca3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run an example and handle the potential exceptions it throws. <a href="#a4c9395db2c8b8d0c336656a7b58fca3e">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000160<tr class="separator:a4c9395db2c8b8d0c336656a7b58fca3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100161<tr class="memitem:ad1b5373f466a3945e1f0ef1c9943c357"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;rect, uint8_t r, uint8_t g, uint8_t b)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100162<tr class="memdesc:ad1b5373f466a3945e1f0ef1c9943c357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a RGB rectangular window for the detected object. <a href="#ad1b5373f466a3945e1f0ef1c9943c357">More...</a><br/></td></tr>
Anthony Barbier46d59272017-05-04 09:15:15 +0100163<tr class="separator:ad1b5373f466a3945e1f0ef1c9943c357"><td class="memSeparator" colspan="2">&#160;</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100164<tr class="memitem:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; unsigned int, <br class="typebreak"/>
165unsigned int, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a3aa8f5f1b94f88fdf5b43a53e29379cf">parse_ppm_header</a> (std::ifstream &amp;fs)</td></tr>
166<tr class="memdesc:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the ppm header from an input file stream. <a href="#a3aa8f5f1b94f88fdf5b43a53e29379cf">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000167<tr class="separator:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100168<tr class="memitem:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
169<tr class="memitem:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a9c3303817ba653b5d1e78efb88d02bcf">map</a> (T &amp;tensor, bool blocking)</td></tr>
170<tr class="memdesc:a9c3303817ba653b5d1e78efb88d02bcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps a tensor if needed. <a href="#a9c3303817ba653b5d1e78efb88d02bcf">More...</a><br/></td></tr>
171<tr class="separator:a9c3303817ba653b5d1e78efb88d02bcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
172<tr class="memitem:a4ff2134cb88cb5a27120cddb98b59774"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
173<tr class="memitem:a4ff2134cb88cb5a27120cddb98b59774"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a4ff2134cb88cb5a27120cddb98b59774">unmap</a> (T &amp;tensor)</td></tr>
174<tr class="memdesc:a4ff2134cb88cb5a27120cddb98b59774"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unmaps a tensor if needed. <a href="#a4ff2134cb88cb5a27120cddb98b59774">More...</a><br/></td></tr>
175<tr class="separator:a4ff2134cb88cb5a27120cddb98b59774"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100176<tr class="memitem:a301d0b7bfd70f73fc1924f4281938d08"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
177<tr class="memitem:a301d0b7bfd70f73fc1924f4281938d08"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">save_to_ppm</a> (T &amp;tensor, const std::string &amp;ppm_filename)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100178<tr class="memdesc:a301d0b7bfd70f73fc1924f4281938d08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template helper function to save a tensor image to a PPM file. <a href="#a301d0b7bfd70f73fc1924f4281938d08">More...</a><br/></td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100179<tr class="separator:a301d0b7bfd70f73fc1924f4281938d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100180<tr class="memitem:af214346f90d640ac468dd90fa2a275cc"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
181<tr class="memitem:af214346f90d640ac468dd90fa2a275cc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#af214346f90d640ac468dd90fa2a275cc">load_trained_data</a> (T &amp;tensor, const std::string &amp;filename)</td></tr>
182<tr class="memdesc:af214346f90d640ac468dd90fa2a275cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load the tensor with pre-trained data from a binary file. <a href="#af214346f90d640ac468dd90fa2a275cc">More...</a><br/></td></tr>
183<tr class="separator:af214346f90d640ac468dd90fa2a275cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<tr class="memitem:a7990fd2b875e2f6d4c1eded54539cb19"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a7990fd2b875e2f6d4c1eded54539cb19">get_typestring</a> (DataType data_type)</td></tr>
185<tr class="memdesc:a7990fd2b875e2f6d4c1eded54539cb19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain numpy type string from DataType. <a href="#a7990fd2b875e2f6d4c1eded54539cb19">More...</a><br/></td></tr>
186<tr class="separator:a7990fd2b875e2f6d4c1eded54539cb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000187</table>
188</div><!-- contents -->
189</div><!-- doc-content -->
190<!-- start footer part -->
191<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
192 <ul>
Kaizen8938bd32017-09-28 14:38:23 +0100193 <li class="navelem"><a class="el" href="dir_29327135a2a2ef098aeaaf2df19d2f1d.xhtml">utils</a></li><li class="navelem"><a class="el" href="utils_2_utils_8h.xhtml">Utils.h</a></li>
Kaizenbf8b01d2017-10-12 14:26:51 +0100194 <li class="footer">Generated on Thu Oct 12 2017 14:26:34 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000195 <a href="http://www.doxygen.org/index.html">
Kaizen8938bd32017-09-28 14:38:23 +0100196 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000197 </ul>
198</div>
199</body>
200</html>