blob: c9e5f3f73fec235df6174996a1aea5d87e43f2be [file] [log] [blame]
Jenkins514be652019-02-28 12:25:18 +00001<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
Anthony Barbier871448e2017-03-24 14:54:29 +00003<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Jenkins514be652019-02-28 12:25:18 +00008<meta name="generator" content="Doxygen 1.8.15"/>
Anthony Barbier871448e2017-03-24 14:54:29 +00009<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +010010<title>Compute Library: utils/Utils.cpp File Reference</title>
Anthony Barbier871448e2017-03-24 14:54:29 +000011<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000016<script type="text/javascript" src="navtreedata.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000017<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000019/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbier871448e2017-03-24 14:54:29 +000020 $(document).ready(initResizable);
Jenkins514be652019-02-28 12:25:18 +000021/* @license-end */</script>
Anthony Barbier871448e2017-03-24 14:54:29 +000022<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000023<script type="text/javascript" src="search/searchdata.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000024<script type="text/javascript" src="search/search.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000025<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Jenkins514be652019-02-28 12:25:18 +000030</script><script type="text/javascript" async="async" 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" />
Jenkins514be652019-02-28 12:25:18 +000032<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000033</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
Jenkins514be652019-02-28 12:25:18 +000040 <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000041 <td style="padding-left: 0.5em;">
Jenkins514be652019-02-28 12:25:18 +000042 <div id="projectname">
Jenkins575c81f2020-03-05 16:07:35 +000043 &#160;<span id="projectnumber">20.02.1</span>
Anthony Barbier871448e2017-03-24 14:54:29 +000044 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
Jenkins514be652019-02-28 12:25:18 +000051<!-- Generated by Doxygen 1.8.15 -->
Anthony Barbier871448e2017-03-24 14:54:29 +000052<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000053/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbier871448e2017-03-24 14:54:29 +000054var searchBox = new SearchBox("searchBox", "search",false,'Search');
Jenkins514be652019-02-28 12:25:18 +000055/* @license-end */
Anthony Barbier871448e2017-03-24 14:54:29 +000056</script>
Jenkinsb9abeae2018-11-22 11:58:08 +000057<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000060/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb9abeae2018-11-22 11:58:08 +000061$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
Jenkins514be652019-02-28 12:25:18 +000065/* @license-end */</script>
Jenkinsb9abeae2018-11-22 11:58:08 +000066<div id="main-nav"></div>
Anthony Barbier871448e2017-03-24 14:54:29 +000067</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000079/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbierdbdab852017-06-23 15:42:00 +010080$(document).ready(function(){initNavTree('utils_2_utils_8cpp.xhtml','');});
Jenkins514be652019-02-28 12:25:18 +000081/* @license-end */
Anthony Barbier871448e2017-03-24 14:54:29 +000082</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
Anthony Barbier8140e1e2017-12-14 23:48:46 +000089</div>
Anthony Barbier871448e2017-03-24 14:54:29 +000090
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="summary">
Anthony Barbier871448e2017-03-24 14:54:29 +0000100<a href="#namespaces">Namespaces</a> &#124;
Jenkinsb9abeae2018-11-22 11:58:08 +0000101<a href="#define-members">Macros</a> &#124;
Anthony Barbierdbdab852017-06-23 15:42:00 +0100102<a href="#func-members">Functions</a> </div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000103 <div class="headertitle">
Anthony Barbierdbdab852017-06-23 15:42:00 +0100104<div class="title">Utils.cpp File Reference</div> </div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000105</div><!--header-->
106<div class="contents">
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000107<div class="textblock"><code>#include &quot;<a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>&quot;</code><br />
108<code>#include &lt;cctype&gt;</code><br />
109<code>#include &lt;cerrno&gt;</code><br />
110<code>#include &lt;iomanip&gt;</code><br />
111<code>#include &lt;string&gt;</code><br />
Jenkinsb9abeae2018-11-22 11:58:08 +0000112<code>#include &quot;stb/stb_image.h&quot;</code><br />
Anthony Barbier871448e2017-03-24 14:54:29 +0000113</div>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100114<p><a href="utils_2_utils_8cpp_source.xhtml">Go to the source code of this file.</a></p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000115<table class="memberdecls">
Anthony Barbier871448e2017-03-24 14:54:29 +0000116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
117Namespaces</h2></td></tr>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000118<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>
Jenkins36ccc902020-02-21 11:10:48 +0000119<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2020 ARM Limited. <br /></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000120<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000121<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 Barbierdbdab852017-06-23 15:42:00 +0100122<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000123</table><table class="memberdecls">
Jenkinsb9abeae2018-11-22 11:58:08 +0000124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
125Macros</h2></td></tr>
126<tr class="memitem:a18372412ad2fc3ce1e3240b3cf0efe78"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utils_2_utils_8cpp.xhtml#a18372412ad2fc3ce1e3240b3cf0efe78">STB_IMAGE_IMPLEMENTATION</a></td></tr>
127<tr class="separator:a18372412ad2fc3ce1e3240b3cf0efe78"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table><table class="memberdecls">
Anthony Barbierdbdab852017-06-23 15:42:00 +0100129<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
130Functions</h2></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100131<tr class="memitem:a8249d4be92399495c0d3c9a5004aeb40"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a8249d4be92399495c0d3c9a5004aeb40">run_example</a> (int argc, char **argv, std::unique_ptr&lt; Example &gt; example)</td></tr>
132<tr class="memdesc:a8249d4be92399495c0d3c9a5004aeb40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run an example and handle the potential exceptions it throws. <a href="namespacearm__compute_1_1utils.xhtml#a8249d4be92399495c0d3c9a5004aeb40">More...</a><br /></td></tr>
133<tr class="separator:a8249d4be92399495c0d3c9a5004aeb40"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100134<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>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000135<tr class="memdesc:ad1b5373f466a3945e1f0ef1c9943c357"><td class="mdescLeft">&#160;</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>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100136<tr class="separator:ad1b5373f466a3945e1f0ef1c9943c357"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000137<tr class="memitem:a779702024b509e6797b2d526d382cf65"><td class="memItemLeft" align="right" valign="top">ImageType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a779702024b509e6797b2d526d382cf65">get_image_type_from_file</a> (const std::string &amp;filename)</td></tr>
138<tr class="memdesc:a779702024b509e6797b2d526d382cf65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets image type given a file. <a href="namespacearm__compute_1_1utils.xhtml#a779702024b509e6797b2d526d382cf65">More...</a><br /></td></tr>
139<tr class="separator:a779702024b509e6797b2d526d382cf65"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000140<tr class="memitem:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; unsigned int, unsigned 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>
141<tr class="memdesc:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="mdescLeft">&#160;</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>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100142<tr class="separator:a3aa8f5f1b94f88fdf5b43a53e29379cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000143<tr class="memitem:acdab4f47904c52221c85cc80f408f183"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; std::vector&lt; unsigned long &gt;, bool, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#acdab4f47904c52221c85cc80f408f183">parse_npy_header</a> (std::ifstream &amp;fs)</td></tr>
144<tr class="memdesc:acdab4f47904c52221c85cc80f408f183"><td class="mdescLeft">&#160;</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>
145<tr class="separator:acdab4f47904c52221c85cc80f408f183"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier06ea0482018-02-22 15:45:35 +0000146<tr class="memitem:afb7b08e5c044dba650037628089a4e7c"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#afb7b08e5c044dba650037628089a4e7c">get_mem_free_from_meminfo</a> ()</td></tr>
147<tr class="memdesc:afb7b08e5c044dba650037628089a4e7c"><td class="mdescLeft">&#160;</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>
148<tr class="separator:afb7b08e5c044dba650037628089a4e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins975dfe12019-09-02 11:47:54 +0100149<tr class="memitem:a394a7513744bff536de8290ce870fd85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a394a7513744bff536de8290ce870fd85">restore_program_cache_from_file</a> (const std::string &amp;filename)</td></tr>
150<tr class="memdesc:a394a7513744bff536de8290ce870fd85"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function loads prebuilt opencl kernels from a file. <a href="namespacearm__compute_1_1utils.xhtml#a394a7513744bff536de8290ce870fd85">More...</a><br /></td></tr>
151<tr class="separator:a394a7513744bff536de8290ce870fd85"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a667b4012e6d9b8c07876c7ff5da9f68d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utils.xhtml#a667b4012e6d9b8c07876c7ff5da9f68d">save_program_cache_to_file</a> (const std::string &amp;filename)</td></tr>
153<tr class="memdesc:a667b4012e6d9b8c07876c7ff5da9f68d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function saves opencl kernels library to a file. <a href="namespacearm__compute_1_1utils.xhtml#a667b4012e6d9b8c07876c7ff5da9f68d">More...</a><br /></td></tr>
154<tr class="separator:a667b4012e6d9b8c07876c7ff5da9f68d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000155</table>
Jenkinsb9abeae2018-11-22 11:58:08 +0000156<h2 class="groupheader">Macro Definition Documentation</h2>
157<a id="a18372412ad2fc3ce1e3240b3cf0efe78"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#a18372412ad2fc3ce1e3240b3cf0efe78">&#9670;&nbsp;</a></span>STB_IMAGE_IMPLEMENTATION</h2>
159
160<div class="memitem">
161<div class="memproto">
162 <table class="memname">
163 <tr>
164 <td class="memname">#define STB_IMAGE_IMPLEMENTATION</td>
165 </tr>
166 </table>
167</div><div class="memdoc">
168
Jenkins0e205f72019-11-28 16:53:35 +0000169<p class="definition">Definition at line <a class="el" href="utils_2_utils_8cpp_source.xhtml#l00040">40</a> of file <a class="el" href="utils_2_utils_8cpp_source.xhtml">Utils.cpp</a>.</p>
Jenkinsb9abeae2018-11-22 11:58:08 +0000170
171</div>
172</div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000173</div><!-- contents -->
174</div><!-- doc-content -->
175<!-- start footer part -->
176<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
177 <ul>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000178 <li class="navelem"><a class="el" href="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.xhtml">utils</a></li><li class="navelem"><a class="el" href="utils_2_utils_8cpp.xhtml">Utils.cpp</a></li>
Jenkins575c81f2020-03-05 16:07:35 +0000179 <li class="footer">Generated on Thu Mar 5 2020 16:07:08 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000180 <a href="http://www.doxygen.org/index.html">
Jenkins514be652019-02-28 12:25:18 +0000181 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000182 </ul>
183</div>
184</body>
185</html>