IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/classarmnn_1_1_ref_memory_manager_1_1_pool.html b/Documentation/classarmnn_1_1_ref_memory_manager_1_1_pool.html
new file mode 100644
index 0000000..6547128
--- /dev/null
+++ b/Documentation/classarmnn_1_1_ref_memory_manager_1_1_pool.html
@@ -0,0 +1,254 @@
+<!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.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: RefMemoryManager::Pool 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">
+ $(document).ready(initResizable);
+</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>
+<link href="doxygen.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;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</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">
+$(document).ready(function(){initNavTree('classarmnn_1_1_ref_memory_manager_1_1_pool.html','');});
+</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> |
+<a href="classarmnn_1_1_ref_memory_manager_1_1_pool-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">RefMemoryManager::Pool Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a>></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:a3661b84570333e6f38f9b8a1ed73b309"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a3661b84570333e6f38f9b8a1ed73b309">Pool</a> (unsigned int numBytes)</td></tr>
+<tr class="separator:a3661b84570333e6f38f9b8a1ed73b309"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ad680831415106b724bd752599cfc42c3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ad680831415106b724bd752599cfc42c3">~Pool</a> ()</td></tr>
+<tr class="separator:ad680831415106b724bd752599cfc42c3"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ab91dc804181f48b0b445ac1299c36c05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ab91dc804181f48b0b445ac1299c36c05">Acquire</a> ()</td></tr>
+<tr class="separator:ab91dc804181f48b0b445ac1299c36c05"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a94c93747c8daa99d65c2a04c6be0748c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a> ()</td></tr>
+<tr class="separator:a94c93747c8daa99d65c2a04c6be0748c"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a6a5db07a5f1fad654e844c52bf702384"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a6a5db07a5f1fad654e844c52bf702384">GetPointer</a> ()</td></tr>
+<tr class="separator:a6a5db07a5f1fad654e844c52bf702384"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">Reserve</a> (unsigned int numBytes)</td></tr>
+<tr class="separator:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memSeparator" colspan="2"> </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="_ref_memory_manager_8hpp_source.html#l00033">33</a> of file <a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
+<a id="a3661b84570333e6f38f9b8a1ed73b309"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3661b84570333e6f38f9b8a1ed73b309">◆ </a></span>Pool()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html">Pool</a> </td>
+ <td>(</td>
+ <td class="paramtype">unsigned int </td>
+ <td class="paramname"><em>numBytes</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00063">63</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  : m_Size(numBytes),</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  m_Pointer(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {}</div></div><!-- fragment -->
+</div>
+</div>
+<a id="ad680831415106b724bd752599cfc42c3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad680831415106b724bd752599cfc42c3">◆ </a></span>~Pool()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">~<a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html">Pool</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="_ref_memory_manager_8cpp_source.html#l00068">68</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+
+<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.html#l00094">RefMemoryManager::Pool::Release()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (m_Pointer)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div><div class="ttc" id="classarmnn_1_1_ref_memory_manager_1_1_pool_html_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">armnn::RefMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_ref_memory_manager_8cpp_source.html#l00094">RefMemoryManager.cpp:94</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="ab91dc804181f48b0b445ac1299c36c05"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab91dc804181f48b0b445ac1299c36c05">◆ </a></span>Acquire()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Acquire </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="_ref_memory_manager_8cpp_source.html#l00088">88</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  BOOST_ASSERT_MSG(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Acquire() called when memory already acquired"</span>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<a id="a6a5db07a5f1fad654e844c52bf702384"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6a5db07a5f1fad654e844c52bf702384">◆ </a></span>GetPointer()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void * GetPointer </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="_ref_memory_manager_8cpp_source.html#l00076">76</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.html#l00042">RefMemoryManager::GetPointer()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  BOOST_ASSERT_MSG(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::GetPointer() called when memory not acquired"</span>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> m_Pointer;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<a id="a94c93747c8daa99d65c2a04c6be0748c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a94c93747c8daa99d65c2a04c6be0748c">◆ </a></span>Release()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Release </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="_ref_memory_manager_8cpp_source.html#l00094">94</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.html#l00068">RefMemoryManager::Pool::~Pool()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  BOOST_ASSERT_MSG(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Release() called when memory not acquired"</span>);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ::operator <span class="keyword">delete</span>(m_Pointer);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  m_Pointer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">◆ </a></span>Reserve()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Reserve </td>
+ <td>(</td>
+ <td class="paramtype">unsigned int </td>
+ <td class="paramname"><em>numBytes</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00082">82</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.html#l00020">RefMemoryManager::Manage()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  BOOST_ASSERT_MSG(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Reserve() cannot be called after memory acquired"</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  m_Size = std::max(m_Size, numBytes);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a></li>
+<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.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="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager.html">RefMemoryManager</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html">Pool</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:07:05 for ArmNN by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+ </ul>
+</div>
+</body>
+</html>