diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/_i_serializer_8hpp_source.xhtml | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/_i_serializer_8hpp_source.xhtml')
-rw-r--r-- | Documentation/_i_serializer_8hpp_source.xhtml | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/Documentation/_i_serializer_8hpp_source.xhtml b/Documentation/_i_serializer_8hpp_source.xhtml new file mode 100644 index 0000000000..75c75360ec --- /dev/null +++ b/Documentation/_i_serializer_8hpp_source.xhtml @@ -0,0 +1,126 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: include/armnnSerializer/ISerializer.hpp Source File</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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</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('_i_serializer_8hpp_source.xhtml','');}); +</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="headertitle"> +<div class="title">ISerializer.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_i_serializer_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="_i_network_8hpp.xhtml">armnn/INetwork.hpp</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="_network_fwd_8hpp.xhtml">armnn/NetworkFwd.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="_types_8hpp.xhtml">armnn/Types.hpp</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="namespacearmnn_serializer.xhtml"> 11</a></span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn_serializer.xhtml">armnnSerializer</a></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">class </span><a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml">ISerializer</a>;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespacearmnn_serializer.xhtml#a550a83250b3ddebf15d5c13c224e3609"> 15</a></span> <span class="keyword">using</span> <a class="code" href="namespacearmnn_serializer.xhtml#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> = std::unique_ptr<ISerializer, void(*)(ISerializer* serializer)>;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classarmnn_serializer_1_1_i_serializer.xhtml"> 17</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml">ISerializer</a></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">static</span> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml">ISerializer</a>* <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#a782a973f05e8615c6dc9441b0dba067f">CreateRaw</a>();</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">static</span> <a class="code" href="namespacearmnn_serializer.xhtml#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#a3c51b5b078572dee02528bfae7202524">Create</a>();</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#a97f01015b8ee3badf4dc3ce4cd6a70c8">Destroy</a>(<a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml">ISerializer</a>* <a class="code" href="namespacearmnn_serializer.xhtml">serializer</a>);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// Serializes the network to ArmNN SerializedGraph.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// @param [in] inNetwork The network to be serialized.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#a3f1d55c3b9478dbef29d28ac46704d3a">Serialize</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_i_network.xhtml">armnn::INetwork</a>& inNetwork) = 0;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// Serializes the SerializedGraph to the stream.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// @param [stream] the stream to save to</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// @return true if graph is Serialized to the Stream, false otherwise</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#a2bc65eae8908204521c9638cd7ae75ae">SaveSerializedToStream</a>(std::ostream& stream) = 0;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarmnn_serializer_1_1_i_serializer.xhtml#ac19559aa86fd8ad84c26a5ded51c72fb"> 34</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_serializer_1_1_i_serializer.xhtml#ac19559aa86fd8ad84c26a5ded51c72fb">~ISerializer</a>() {}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> };</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> } <span class="comment">//namespace armnnSerializer</span></div><div class="ttc" id="namespacearmnn_serializer_xhtml"><div class="ttname"><a href="namespacearmnn_serializer.xhtml">armnnSerializer</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.xhtml#l00011">ISerializer.hpp:11</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_a782a973f05e8615c6dc9441b0dba067f"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#a782a973f05e8615c6dc9441b0dba067f">armnnSerializer::ISerializer::CreateRaw</a></div><div class="ttdeci">static ISerializer * CreateRaw()</div><div class="ttdef"><b>Definition:</b> <a href="_serializer_8cpp_source.xhtml#l01549">Serializer.cpp:1549</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_a3f1d55c3b9478dbef29d28ac46704d3a"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#a3f1d55c3b9478dbef29d28ac46704d3a">armnnSerializer::ISerializer::Serialize</a></div><div class="ttdeci">virtual void Serialize(const armnn::INetwork &inNetwork)=0</div><div class="ttdoc">Serializes the network to ArmNN SerializedGraph. </div></div> +<div class="ttc" id="classarmnn_1_1_i_network_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_network.xhtml">armnn::INetwork</a></div><div class="ttdoc">Main network class which provides the interface for building up a neural network. ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_network_8hpp_source.xhtml#l00105">INetwork.hpp:105</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_a2bc65eae8908204521c9638cd7ae75ae"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#a2bc65eae8908204521c9638cd7ae75ae">armnnSerializer::ISerializer::SaveSerializedToStream</a></div><div class="ttdeci">virtual bool SaveSerializedToStream(std::ostream &stream)=0</div><div class="ttdoc">Serializes the SerializedGraph to the stream. </div></div> +<div class="ttc" id="_types_8hpp_xhtml"><div class="ttname"><a href="_types_8hpp.xhtml">Types.hpp</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml">armnnSerializer::ISerializer</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.xhtml#l00017">ISerializer.hpp:17</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_ac19559aa86fd8ad84c26a5ded51c72fb"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#ac19559aa86fd8ad84c26a5ded51c72fb">armnnSerializer::ISerializer::~ISerializer</a></div><div class="ttdeci">virtual ~ISerializer()</div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.xhtml#l00034">ISerializer.hpp:34</a></div></div> +<div class="ttc" id="_i_network_8hpp_xhtml"><div class="ttname"><a href="_i_network_8hpp.xhtml">INetwork.hpp</a></div></div> +<div class="ttc" id="namespacearmnn_serializer_xhtml_a550a83250b3ddebf15d5c13c224e3609"><div class="ttname"><a href="namespacearmnn_serializer.xhtml#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.xhtml#l00015">ISerializer.hpp:15</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_a3c51b5b078572dee02528bfae7202524"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#a3c51b5b078572dee02528bfae7202524">armnnSerializer::ISerializer::Create</a></div><div class="ttdeci">static ISerializerPtr Create()</div><div class="ttdef"><b>Definition:</b> <a href="_serializer_8cpp_source.xhtml#l01554">Serializer.cpp:1554</a></div></div> +<div class="ttc" id="_network_fwd_8hpp_xhtml"><div class="ttname"><a href="_network_fwd_8hpp.xhtml">NetworkFwd.hpp</a></div></div> +<div class="ttc" id="classarmnn_serializer_1_1_i_serializer_xhtml_a97f01015b8ee3badf4dc3ce4cd6a70c8"><div class="ttname"><a href="classarmnn_serializer_1_1_i_serializer.xhtml#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.xhtml#l01559">Serializer.cpp:1559</a></div></div> +</div><!-- fragment --></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="dir_d44c64559bbebec7f509842c48db8b23.xhtml">include</a></li><li class="navelem"><a class="el" href="dir_e2b12e69186a743e61b71686529ee0e9.xhtml">armnnSerializer</a></li><li class="navelem"><a class="el" href="_i_serializer_8hpp.xhtml">ISerializer.hpp</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:08 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> |