Google Git
Sign in
android / platform / external / ComputeLibrary / e8521c234 / . / documentation / classarm__compute_1_1_m_e_m_info.xhtml
blob: ef06e50b4c75b88947eb02fdea1f4afec427b92a [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: MEMInfo 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="stylesheet.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="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"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('classarm__compute_1_1_m_e_m_info.xhtml','');});
/* @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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">MEMInfo Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_c_p_p_types_8h_source.xhtml">CPPTypes.h</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:a8e6211e81e33a09af138b842ab4d8534"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a8e6211e81e33a09af138b842ab4d8534">MEMInfo</a> ()</td></tr>
<tr class="separator:a8e6211e81e33a09af138b842ab4d8534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a417a573b0ef6347fa727ce756b76f1d2"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a417a573b0ef6347fa727ce756b76f1d2">get_total_in_kb</a> () const</td></tr>
<tr class="memdesc:a417a573b0ef6347fa727ce756b76f1d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the total amount of RAM memory in the system expressed in KB. <a href="#a417a573b0ef6347fa727ce756b76f1d2">More...</a><br /></td></tr>
<tr class="separator:a417a573b0ef6347fa727ce756b76f1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1609b8101beb35633a19f845d22323a8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a1609b8101beb35633a19f845d22323a8">set_policy</a> (<a class="el" href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495">MemoryPolicy</a> policy)</td></tr>
<tr class="separator:a1609b8101beb35633a19f845d22323a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacc842e7ef6389e970d92af1d62793a7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495">MemoryPolicy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#aacc842e7ef6389e970d92af1d62793a7">get_policy</a> ()</td></tr>
<tr class="separator:aacc842e7ef6389e970d92af1d62793a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a2ac5f0a5b7dccb10d5bf9bffd33879fa"><td class="memItemLeft" align="right" valign="top">static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a2ac5f0a5b7dccb10d5bf9bffd33879fa">ONE_GB_IN_KB</a> = { 1035842 }</td></tr>
<tr class="memdesc:a2ac5f0a5b7dccb10d5bf9bffd33879fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common memory sizes expressed in Kb to avoid having them duplicated throughout the code. <a href="#a2ac5f0a5b7dccb10d5bf9bffd33879fa">More...</a><br /></td></tr>
<tr class="separator:a2ac5f0a5b7dccb10d5bf9bffd33879fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd0ddfc9f23b25d70cdcf6e2e0d37782"><td class="memItemLeft" align="right" valign="top">static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#abd0ddfc9f23b25d70cdcf6e2e0d37782">TWO_GB_IN_KB</a> = { <a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a2ac5f0a5b7dccb10d5bf9bffd33879fa">ONE_GB_IN_KB</a> * 2 }</td></tr>
<tr class="separator:abd0ddfc9f23b25d70cdcf6e2e0d37782"><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 class="definition">Definition at line <a class="el" href="_c_p_p_types_8h_source.xhtml#l00197">197</a> of file <a class="el" href="_c_p_p_types_8h_source.xhtml">CPPTypes.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8e6211e81e33a09af138b842ab4d8534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e6211e81e33a09af138b842ab4d8534">&#9670;&nbsp;</a></span>MEMInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml">MEMInfo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_m_e_m_utils_8cpp_source.xhtml#l00092">92</a> of file <a class="el" href="_m_e_m_utils_8cpp_source.xhtml">MEMUtils.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; : _total(0), _free(0), _buffer(0)</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;{</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; parse_mem_info(_total, _free, _buffer);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aacc842e7ef6389e970d92af1d62793a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc842e7ef6389e970d92af1d62793a7">&#9670;&nbsp;</a></span>get_policy()</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="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495">MemoryPolicy</a> get_policy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_m_e_m_utils_8cpp_source.xhtml#l00086">86</a> of file <a class="el" href="_m_e_m_utils_8cpp_source.xhtml">MEMUtils.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;{</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> _policy;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_n_e_g_e_m_m_8cpp_source.xhtml#l00051">NEGEMM::configure()</a>.</p>
</div>
</div>
<a id="a417a573b0ef6347fa727ce756b76f1d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a417a573b0ef6347fa727ce756b76f1d2">&#9670;&nbsp;</a></span>get_total_in_kb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t get_total_in_kb </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the total amount of RAM memory in the system expressed in KB. </p>
<dl class="section return"><dt>Returns</dt><dd>Total memory </dd></dl>
<p class="definition">Definition at line <a class="el" href="_m_e_m_utils_8cpp_source.xhtml#l00098">98</a> of file <a class="el" href="_m_e_m_utils_8cpp_source.xhtml">MEMUtils.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;{</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> _total;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="a1609b8101beb35633a19f845d22323a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1609b8101beb35633a19f845d22323a8">&#9670;&nbsp;</a></span>set_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void set_policy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495">MemoryPolicy</a>&#160;</td>
<td class="paramname"><em>policy</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_m_e_m_utils_8cpp_source.xhtml#l00081">81</a> of file <a class="el" href="_m_e_m_utils_8cpp_source.xhtml">MEMUtils.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;{</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; _policy = <a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#ad986b73e9d5f47a623a9b6d773c25e34">policy</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}</div><div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_ad986b73e9d5f47a623a9b6d773c25e34"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#ad986b73e9d5f47a623a9b6d773c25e34">arm_compute::test::validation::policy</a></div><div class="ttdeci">policy</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_2_arithmetic_addition_8cpp_source.xhtml#l00139">ArithmeticAddition.cpp:139</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_c_l_2_arithmetic_addition_8cpp_source.xhtml#l00139">arm_compute::test::validation::policy</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a2ac5f0a5b7dccb10d5bf9bffd33879fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac5f0a5b7dccb10d5bf9bffd33879fa">&#9670;&nbsp;</a></span>ONE_GB_IN_KB</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const size_t ONE_GB_IN_KB = { 1035842 }</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Common memory sizes expressed in Kb to avoid having them duplicated throughout the code. </p>
<p class="definition">Definition at line <a class="el" href="_c_p_p_types_8h_source.xhtml#l00214">214</a> of file <a class="el" href="_c_p_p_types_8h_source.xhtml">CPPTypes.h</a>.</p>
</div>
</div>
<a id="abd0ddfc9f23b25d70cdcf6e2e0d37782"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd0ddfc9f23b25d70cdcf6e2e0d37782">&#9670;&nbsp;</a></span>TWO_GB_IN_KB</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const size_t TWO_GB_IN_KB = { <a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml#a2ac5f0a5b7dccb10d5bf9bffd33879fa">ONE_GB_IN_KB</a> * 2 }</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_c_p_p_types_8h_source.xhtml#l00215">215</a> of file <a class="el" href="_c_p_p_types_8h_source.xhtml">CPPTypes.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/core/CPP/<a class="el" href="_c_p_p_types_8h_source.xhtml">CPPTypes.h</a></li>
<li>src/runtime/<a class="el" href="_m_e_m_utils_8cpp_source.xhtml">MEMUtils.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_m_e_m_info.xhtml">MEMInfo</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:14 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>