Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 250d3927b16abe4d6932cd5dce1184bd7026a2b7 / . / Documentation / classarmnn_serializer_1_1_i_serializer.html
blob: f946cb896157627f7558d88edbd9ad58445bf6b6 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: ISerializer Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_serializer_1_1_i_serializer.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
86<a href="#pro-methods">Protected Member Functions</a> &#124;
87<a href="classarmnn_serializer_1_1_i_serializer-members.html">List of all members</a> </div>
88 <div class="headertitle">
89<div class="title">ISerializer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
90</div><!--header-->
91<div class="contents">
92
93<p><code>#include &lt;<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a>&gt;</code></p>
94<div class="dynheader">
95Inheritance diagram for ISerializer:</div>
96<div class="dyncontent">
97 <div class="center">
98 <img src="classarmnn_serializer_1_1_i_serializer.png" usemap="#ISerializer_map" alt=""/>
99 <map id="ISerializer_map" name="ISerializer_map">
100<area href="classarmnn_serializer_1_1_serializer.html" alt="Serializer" shape="rect" coords="0,56,69,80"/>
101</map>
102 </div></div>
103<table class="memberdecls">
104<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
105Public Member Functions</h2></td></tr>
106<tr class="memitem:a3f1d55c3b9478dbef29d28ac46704d3a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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> &amp;inNetwork)=0</td></tr>
107<tr class="separator:a3f1d55c3b9478dbef29d28ac46704d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:a2bc65eae8908204521c9638cd7ae75ae"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a2bc65eae8908204521c9638cd7ae75ae">SaveSerializedToStream</a> (std::ostream &amp;stream)=0</td></tr>
109<tr class="separator:a2bc65eae8908204521c9638cd7ae75ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
110</table><table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
112Static Public Member Functions</h2></td></tr>
113<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> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a782a973f05e8615c6dc9441b0dba067f">CreateRaw</a> ()</td></tr>
114<tr class="separator:a782a973f05e8615c6dc9441b0dba067f"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:a3c51b5b078572dee02528bfae7202524"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a3c51b5b078572dee02528bfae7202524">Create</a> ()</td></tr>
116<tr class="separator:a3c51b5b078572dee02528bfae7202524"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:a97f01015b8ee3badf4dc3ce4cd6a70c8"><td class="memItemLeft" align="right" valign="top">static void&#160;</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>
118<tr class="separator:a97f01015b8ee3badf4dc3ce4cd6a70c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table><table class="memberdecls">
120<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
121Protected Member Functions</h2></td></tr>
122<tr class="memitem:ac19559aa86fd8ad84c26a5ded51c72fb"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#ac19559aa86fd8ad84c26a5ded51c72fb">~ISerializer</a> ()</td></tr>
123<tr class="separator:ac19559aa86fd8ad84c26a5ded51c72fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
124</table>
125<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
126<div class="textblock">
127<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>
128</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
129<a id="ac19559aa86fd8ad84c26a5ded51c72fb"></a>
130<h2 class="memtitle"><span class="permalink"><a href="#ac19559aa86fd8ad84c26a5ded51c72fb">&#9670;&nbsp;</a></span>~ISerializer()</h2>
131
132<div class="memitem">
133<div class="memproto">
134<table class="mlabels">
135 <tr>
136 <td class="mlabels-left">
137 <table class="memname">
138 <tr>
139 <td class="memname">virtual ~<a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> </td>
140 <td>(</td>
141 <td class="paramname"></td><td>)</td>
142 <td></td>
143 </tr>
144 </table>
145 </td>
146 <td class="mlabels-right">
147<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
148 </tr>
149</table>
150</div><div class="memdoc">
151
152<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>
153<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{}</div></div><!-- fragment -->
154</div>
155</div>
156<h2 class="groupheader">Member Function Documentation</h2>
157<a id="a3c51b5b078572dee02528bfae7202524"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#a3c51b5b078572dee02528bfae7202524">&#9670;&nbsp;</a></span>Create()</h2>
159
160<div class="memitem">
161<div class="memproto">
162<table class="mlabels">
163 <tr>
164 <td class="mlabels-left">
165 <table class="memname">
166 <tr>
167 <td class="memname"><a class="el" href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> Create </td>
168 <td>(</td>
169 <td class="paramname"></td><td>)</td>
170 <td></td>
171 </tr>
172 </table>
173 </td>
174 <td class="mlabels-right">
175<span class="mlabels"><span class="mlabel">static</span></span> </td>
176 </tr>
177</table>
178</div><div class="memdoc">
179
180<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>
181
182<p class="reference">Referenced by <a class="el" href="_arm_n_n_quantizer_main_8cpp_source.html#l00017">main()</a>.</p>
183<div class="fragment"><div class="line"><a name="l01524"></a><span class="lineno"> 1524</span>&#160;{</div><div class="line"><a name="l01525"></a><span class="lineno"> 1525</span>&#160; <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>(), &amp;<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>&#160;}</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&lt; ISerializer, void(*)(ISerializer *serializer)&gt; ISerializerPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_serializer_8hpp_source.html#l00015">ISerializer.hpp:15</a></div></div>
184<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>
185<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>
186</div><!-- fragment -->
187</div>
188</div>
189<a id="a782a973f05e8615c6dc9441b0dba067f"></a>
190<h2 class="memtitle"><span class="permalink"><a href="#a782a973f05e8615c6dc9441b0dba067f">&#9670;&nbsp;</a></span>CreateRaw()</h2>
191
192<div class="memitem">
193<div class="memproto">
194<table class="mlabels">
195 <tr>
196 <td class="mlabels-left">
197 <table class="memname">
198 <tr>
199 <td class="memname"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> * CreateRaw </td>
200 <td>(</td>
201 <td class="paramname"></td><td>)</td>
202 <td></td>
203 </tr>
204 </table>
205 </td>
206 <td class="mlabels-right">
207<span class="mlabels"><span class="mlabel">static</span></span> </td>
208 </tr>
209</table>
210</div><div class="memdoc">
211
212<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>
213<div class="fragment"><div class="line"><a name="l01519"></a><span class="lineno"> 1519</span>&#160;{</div><div class="line"><a name="l01520"></a><span class="lineno"> 1520</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> Serializer();</div><div class="line"><a name="l01521"></a><span class="lineno"> 1521</span>&#160;}</div></div><!-- fragment -->
214</div>
215</div>
216<a id="a97f01015b8ee3badf4dc3ce4cd6a70c8"></a>
217<h2 class="memtitle"><span class="permalink"><a href="#a97f01015b8ee3badf4dc3ce4cd6a70c8">&#9670;&nbsp;</a></span>Destroy()</h2>
218
219<div class="memitem">
220<div class="memproto">
221<table class="mlabels">
222 <tr>
223 <td class="mlabels-left">
224 <table class="memname">
225 <tr>
226 <td class="memname">void Destroy </td>
227 <td>(</td>
228 <td class="paramtype"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> *&#160;</td>
229 <td class="paramname"><em>serializer</em></td><td>)</td>
230 <td></td>
231 </tr>
232 </table>
233 </td>
234 <td class="mlabels-right">
235<span class="mlabels"><span class="mlabel">static</span></span> </td>
236 </tr>
237</table>
238</div><div class="memdoc">
239
240<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>
241<div class="fragment"><div class="line"><a name="l01529"></a><span class="lineno"> 1529</span>&#160;{</div><div class="line"><a name="l01530"></a><span class="lineno"> 1530</span>&#160; <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>&#160;}</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>
242</div><!-- fragment -->
243</div>
244</div>
245<a id="a2bc65eae8908204521c9638cd7ae75ae"></a>
246<h2 class="memtitle"><span class="permalink"><a href="#a2bc65eae8908204521c9638cd7ae75ae">&#9670;&nbsp;</a></span>SaveSerializedToStream()</h2>
247
248<div class="memitem">
249<div class="memproto">
250<table class="mlabels">
251 <tr>
252 <td class="mlabels-left">
253 <table class="memname">
254 <tr>
255 <td class="memname">virtual bool SaveSerializedToStream </td>
256 <td>(</td>
257 <td class="paramtype">std::ostream &amp;&#160;</td>
258 <td class="paramname"><em>stream</em></td><td>)</td>
259 <td></td>
260 </tr>
261 </table>
262 </td>
263 <td class="mlabels-right">
264<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
265 </tr>
266</table>
267</div><div class="memdoc">
268<p>Serializes the SerializedGraph to the stream. </p><dl class="params"><dt>Parameters</dt><dd>
269 <table class="params">
270 <tr><td class="paramname">[stream]</td><td>the stream to save to </td></tr>
271 </table>
272 </dd>
273</dl>
274<dl class="section return"><dt>Returns</dt><dd>true if graph is Serialized to the Stream, false otherwise </dd></dl>
275
276<p>Implemented in <a class="el" href="classarmnn_serializer_1_1_serializer.html#af21f36069c661c4afa7221a305de80e0">Serializer</a>.</p>
277
278</div>
279</div>
280<a id="a3f1d55c3b9478dbef29d28ac46704d3a"></a>
281<h2 class="memtitle"><span class="permalink"><a href="#a3f1d55c3b9478dbef29d28ac46704d3a">&#9670;&nbsp;</a></span>Serialize()</h2>
282
283<div class="memitem">
284<div class="memproto">
285<table class="mlabels">
286 <tr>
287 <td class="mlabels-left">
288 <table class="memname">
289 <tr>
290 <td class="memname">virtual void Serialize </td>
291 <td>(</td>
292 <td class="paramtype">const <a class="el" href="classarmnn_1_1_i_network.html">armnn::INetwork</a> &amp;&#160;</td>
293 <td class="paramname"><em>inNetwork</em></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </td>
298 <td class="mlabels-right">
299<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
300 </tr>
301</table>
302</div><div class="memdoc">
303<p>Serializes the network to ArmNN SerializedGraph. </p><dl class="params"><dt>Parameters</dt><dd>
304 <table class="params">
305 <tr><td class="paramdir">[in]</td><td class="paramname">inNetwork</td><td>The network to be serialized. </td></tr>
306 </table>
307 </dd>
308</dl>
309
310<p>Implemented in <a class="el" href="classarmnn_serializer_1_1_serializer.html#a62dbb19d4776b489161b699f608f0150">Serializer</a>.</p>
311
312</div>
313</div>
314<hr/>The documentation for this class was generated from the following files:<ul>
315<li>include/armnnSerializer/<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a></li>
316<li>src/armnnSerializer/<a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a></li>
317</ul>
318</div><!-- contents -->
319</div><!-- doc-content -->
320<!-- start footer part -->
321<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
322 <ul>
323 <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>
324 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
325 <a href="http://www.doxygen.org/index.html">
326 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
327 </ul>
328</div>
329</body>
330</html>