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_serializer_1_1_i_serializer.html b/Documentation/classarmnn_serializer_1_1_i_serializer.html
new file mode 100644
index 0000000..f946cb8
--- /dev/null
+++ b/Documentation/classarmnn_serializer_1_1_i_serializer.html
@@ -0,0 +1,330 @@
+<!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: ISerializer 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_serializer_1_1_i_serializer.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="#pub-static-methods">Static Public Member Functions</a> |
+<a href="#pro-methods">Protected Member Functions</a> |
+<a href="classarmnn_serializer_1_1_i_serializer-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">ISerializer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a>></code></p>
+<div class="dynheader">
+Inheritance diagram for ISerializer:</div>
+<div class="dyncontent">
+ <div class="center">
+ <img src="classarmnn_serializer_1_1_i_serializer.png" usemap="#ISerializer_map" alt=""/>
+ <map id="ISerializer_map" name="ISerializer_map">
+<area href="classarmnn_serializer_1_1_serializer.html" alt="Serializer" shape="rect" coords="0,56,69,80"/>
+</map>
+ </div></div>
+<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:a3f1d55c3b9478dbef29d28ac46704d3a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a3f1d55c3b9478dbef29d28ac46704d3a">Serialize</a> (const <a class="el" href="classarmnn_1_1_i_network.html">armnn::INetwork</a> &inNetwork)=0</td></tr>
+<tr class="separator:a3f1d55c3b9478dbef29d28ac46704d3a"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a2bc65eae8908204521c9638cd7ae75ae"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a2bc65eae8908204521c9638cd7ae75ae">SaveSerializedToStream</a> (std::ostream &stream)=0</td></tr>
+<tr class="separator:a2bc65eae8908204521c9638cd7ae75ae"><td class="memSeparator" colspan="2"> </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:a782a973f05e8615c6dc9441b0dba067f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a782a973f05e8615c6dc9441b0dba067f">CreateRaw</a> ()</td></tr>
+<tr class="separator:a782a973f05e8615c6dc9441b0dba067f"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a3c51b5b078572dee02528bfae7202524"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a3c51b5b078572dee02528bfae7202524">Create</a> ()</td></tr>
+<tr class="separator:a3c51b5b078572dee02528bfae7202524"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a97f01015b8ee3badf4dc3ce4cd6a70c8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a97f01015b8ee3badf4dc3ce4cd6a70c8">Destroy</a> (<a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> *serializer)</td></tr>
+<tr class="separator:a97f01015b8ee3badf4dc3ce4cd6a70c8"><td class="memSeparator" colspan="2"> </td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
+Protected Member Functions</h2></td></tr>
+<tr class="memitem:ac19559aa86fd8ad84c26a5ded51c72fb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#ac19559aa86fd8ad84c26a5ded51c72fb">~ISerializer</a> ()</td></tr>
+<tr class="separator:ac19559aa86fd8ad84c26a5ded51c72fb"><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="_i_serializer_8hpp_source.html#l00017">17</a> of file <a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
+<a id="ac19559aa86fd8ad84c26a5ded51c72fb"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac19559aa86fd8ad84c26a5ded51c72fb">◆ </a></span>~ISerializer()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual ~<a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_serializer_8hpp_source.html#l00034">34</a> of file <a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {}</div></div><!-- fragment -->
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a3c51b5b078572dee02528bfae7202524"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3c51b5b078572dee02528bfae7202524">◆ </a></span>Create()</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="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> Create </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="_serializer_8cpp_source.html#l01523">1523</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_arm_n_n_quantizer_main_8cpp_source.html#l00017">main()</a>.</p>
+<div class="fragment"><div class="line"><a name="l01524"></a><span class="lineno"> 1524</span> {</div><div class="line"><a name="l01525"></a><span class="lineno"> 1525</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a>(<a class="code" href="classarmnn_serializer_1_1_i_serializer.html#a782a973f05e8615c6dc9441b0dba067f">CreateRaw</a>(), &<a class="code" href="classarmnn_serializer_1_1_i_serializer.html#a97f01015b8ee3badf4dc3ce4cd6a70c8">ISerializer::Destroy</a>);</div><div class="line"><a name="l01526"></a><span class="lineno"> 1526</span> }</div><div class="ttc" id="namespacearmnn_serializer_html_a550a83250b3ddebf15d5c13c224e3609"><div class="ttname"><a href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">armnnSerializer::ISerializerPtr</a></div><div class="ttdeci">std::unique_ptr< ISerializer, void(*)(ISerializer *serializer)> ISerializerPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.html#l00015">ISerializer.hpp:15</a></div></div>
+<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_html_a97f01015b8ee3badf4dc3ce4cd6a70c8"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.html#a97f01015b8ee3badf4dc3ce4cd6a70c8">armnnSerializer::ISerializer::Destroy</a></div><div class="ttdeci">static void Destroy(ISerializer *serializer)</div><div class="ttdef"><b>Definition:</b> <a href="_serializer_8cpp_source.html#l01528">Serializer.cpp:1528</a></div></div>
+<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_html_a782a973f05e8615c6dc9441b0dba067f"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.html#a782a973f05e8615c6dc9441b0dba067f">armnnSerializer::ISerializer::CreateRaw</a></div><div class="ttdeci">static ISerializer * CreateRaw()</div><div class="ttdef"><b>Definition:</b> <a href="_serializer_8cpp_source.html#l01518">Serializer.cpp:1518</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a782a973f05e8615c6dc9441b0dba067f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a782a973f05e8615c6dc9441b0dba067f">◆ </a></span>CreateRaw()</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="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> * CreateRaw </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="_serializer_8cpp_source.html#l01518">1518</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l01519"></a><span class="lineno"> 1519</span> {</div><div class="line"><a name="l01520"></a><span class="lineno"> 1520</span>  <span class="keywordflow">return</span> <span class="keyword">new</span> Serializer();</div><div class="line"><a name="l01521"></a><span class="lineno"> 1521</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<a id="a97f01015b8ee3badf4dc3ce4cd6a70c8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a97f01015b8ee3badf4dc3ce4cd6a70c8">◆ </a></span>Destroy()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Destroy </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> * </td>
+ <td class="paramname"><em>serializer</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="_serializer_8cpp_source.html#l01528">1528</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l01529"></a><span class="lineno"> 1529</span> {</div><div class="line"><a name="l01530"></a><span class="lineno"> 1530</span>  <span class="keyword">delete</span> <a class="code" href="namespacearmnn_serializer.html">serializer</a>;</div><div class="line"><a name="l01531"></a><span class="lineno"> 1531</span> }</div><div class="ttc" id="namespacearmnn_serializer_html"><div class="ttname"><a href="namespacearmnn_serializer.html">armnnSerializer</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.html#l00011">ISerializer.hpp:11</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a2bc65eae8908204521c9638cd7ae75ae"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2bc65eae8908204521c9638cd7ae75ae">◆ </a></span>SaveSerializedToStream()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual bool SaveSerializedToStream </td>
+ <td>(</td>
+ <td class="paramtype">std::ostream & </td>
+ <td class="paramname"><em>stream</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+<p>Serializes the SerializedGraph to the stream. </p><dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">[stream]</td><td>the stream to save to </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>true if graph is Serialized to the Stream, false otherwise </dd></dl>
+
+<p>Implemented in <a class="el" href="classarmnn_serializer_1_1_serializer.html#af21f36069c661c4afa7221a305de80e0">Serializer</a>.</p>
+
+</div>
+</div>
+<a id="a3f1d55c3b9478dbef29d28ac46704d3a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3f1d55c3b9478dbef29d28ac46704d3a">◆ </a></span>Serialize()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void Serialize </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="classarmnn_1_1_i_network.html">armnn::INetwork</a> & </td>
+ <td class="paramname"><em>inNetwork</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+<p>Serializes the network to ArmNN SerializedGraph. </p><dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">inNetwork</td><td>The network to be serialized. </td></tr>
+ </table>
+ </dd>
+</dl>
+
+<p>Implemented in <a class="el" href="classarmnn_serializer_1_1_serializer.html#a62dbb19d4776b489161b699f608f0150">Serializer</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>include/armnnSerializer/<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a></li>
+<li>src/armnnSerializer/<a class="el" href="_serializer_8cpp_source.html">Serializer.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_serializer.html">armnnSerializer</a></li><li class="navelem"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:07:06 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>