Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_serializer_1_1_i_serializer.html
blob: 25692a051b46a67acb453624e6e731e9c285b899 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: ISerializer Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_serializer_1_1_i_serializer.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#nested-classes">Classes</a> &#124;
97<a href="#pub-methods">Public Member Functions</a> &#124;
98<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
99<a href="classarmnn_serializer_1_1_i_serializer-members.html">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">ISerializer Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a>&gt;</code></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
108Classes</h2></td></tr>
109<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer_1_1_serializer_impl.html">SerializerImpl</a></td></tr>
110<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
111</table><table class="memberdecls">
112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113Public Member Functions</h2></td></tr>
114<tr class="memitem:a4d146e96f4464192b762b23e1cf1e207"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a4d146e96f4464192b762b23e1cf1e207">Serialize</a> (const <a class="el" href="classarmnn_1_1_i_network.html">armnn::INetwork</a> &amp;inNetwork)</td></tr>
115<tr class="memdesc:a4d146e96f4464192b762b23e1cf1e207"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the network to ArmNN SerializedGraph. <a href="classarmnn_serializer_1_1_i_serializer.html#a4d146e96f4464192b762b23e1cf1e207">More...</a><br /></td></tr>
116<tr class="separator:a4d146e96f4464192b762b23e1cf1e207"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:a049d34980f9dd0a518f9781822a718c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html#a049d34980f9dd0a518f9781822a718c4">SaveSerializedToStream</a> (std::ostream &amp;stream)</td></tr>
118<tr class="memdesc:a049d34980f9dd0a518f9781822a718c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the SerializedGraph to the stream. <a href="classarmnn_serializer_1_1_i_serializer.html#a049d34980f9dd0a518f9781822a718c4">More...</a><br /></td></tr>
119<tr class="separator:a049d34980f9dd0a518f9781822a718c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
120</table><table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
122Static Public Member Functions</h2></td></tr>
123<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>
124<tr class="separator:a782a973f05e8615c6dc9441b0dba067f"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<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>
126<tr class="separator:a3c51b5b078572dee02528bfae7202524"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<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>
128<tr class="separator:a97f01015b8ee3badf4dc3ce4cd6a70c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table>
130<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
131<div class="textblock">
132<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>
133</div><h2 class="groupheader">Member Function Documentation</h2>
134<a id="a3c51b5b078572dee02528bfae7202524"></a>
135<h2 class="memtitle"><span class="permalink"><a href="#a3c51b5b078572dee02528bfae7202524">&#9670;&nbsp;</a></span>Create()</h2>
136
137<div class="memitem">
138<div class="memproto">
139<table class="mlabels">
140 <tr>
141 <td class="mlabels-left">
142 <table class="memname">
143 <tr>
144 <td class="memname"><a class="el" href="namespacearmnn_serializer.html#a550a83250b3ddebf15d5c13c224e3609">ISerializerPtr</a> Create </td>
145 <td>(</td>
146 <td class="paramname"></td><td>)</td>
147 <td></td>
148 </tr>
149 </table>
150 </td>
151 <td class="mlabels-right">
152<span class="mlabels"><span class="mlabel">static</span></span> </td>
153 </tr>
154</table>
155</div><div class="memdoc">
156
157<p class="definition">Definition at line <a class="el" href="_serializer_8cpp_source.html#l00035">35</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
158<div class="fragment"><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
159<div class="line"><a name="l00037"></a><span class="lineno"> 37</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>
160<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
161</div><!-- fragment -->
162<p class="reference">Referenced by <a class="el" href="_canonical_utils_8cpp_source.html#l00432">armnn_driver::SerializeNetwork()</a>.</p>
163
164</div>
165</div>
166<a id="a782a973f05e8615c6dc9441b0dba067f"></a>
167<h2 class="memtitle"><span class="permalink"><a href="#a782a973f05e8615c6dc9441b0dba067f">&#9670;&nbsp;</a></span>CreateRaw()</h2>
168
169<div class="memitem">
170<div class="memproto">
171<table class="mlabels">
172 <tr>
173 <td class="mlabels-left">
174 <table class="memname">
175 <tr>
176 <td class="memname"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> * CreateRaw </td>
177 <td>(</td>
178 <td class="paramname"></td><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182 </td>
183 <td class="mlabels-right">
184<span class="mlabels"><span class="mlabel">static</span></span> </td>
185 </tr>
186</table>
187</div><div class="memdoc">
188
189<p class="definition">Definition at line <a class="el" href="_serializer_8cpp_source.html#l00030">30</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
190<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
191<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> ISerializer();</div>
192<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div>
193</div><!-- fragment -->
194</div>
195</div>
196<a id="a97f01015b8ee3badf4dc3ce4cd6a70c8"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#a97f01015b8ee3badf4dc3ce4cd6a70c8">&#9670;&nbsp;</a></span>Destroy()</h2>
198
199<div class="memitem">
200<div class="memproto">
201<table class="mlabels">
202 <tr>
203 <td class="mlabels-left">
204 <table class="memname">
205 <tr>
206 <td class="memname">void Destroy </td>
207 <td>(</td>
208 <td class="paramtype"><a class="el" href="classarmnn_serializer_1_1_i_serializer.html">ISerializer</a> *&#160;</td>
209 <td class="paramname"><em>serializer</em></td><td>)</td>
210 <td></td>
211 </tr>
212 </table>
213 </td>
214 <td class="mlabels-right">
215<span class="mlabels"><span class="mlabel">static</span></span> </td>
216 </tr>
217</table>
218</div><div class="memdoc">
219
220<p class="definition">Definition at line <a class="el" href="_serializer_8cpp_source.html#l00040">40</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
221<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div>
222<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">delete</span> <a class="code" href="namespacearmnn_serializer.html">serializer</a>;</div>
223<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div>
224</div><!-- fragment -->
225</div>
226</div>
227<a id="a049d34980f9dd0a518f9781822a718c4"></a>
228<h2 class="memtitle"><span class="permalink"><a href="#a049d34980f9dd0a518f9781822a718c4">&#9670;&nbsp;</a></span>SaveSerializedToStream()</h2>
229
230<div class="memitem">
231<div class="memproto">
232 <table class="memname">
233 <tr>
234 <td class="memname">bool SaveSerializedToStream </td>
235 <td>(</td>
236 <td class="paramtype">std::ostream &amp;&#160;</td>
237 <td class="paramname"><em>stream</em></td><td>)</td>
238 <td></td>
239 </tr>
240 </table>
241</div><div class="memdoc">
242
243<p>Serializes the SerializedGraph to the stream. </p>
244<dl class="params"><dt>Parameters</dt><dd>
245 <table class="params">
246 <tr><td class="paramname">[stream]</td><td>the stream to save to </td></tr>
247 </table>
248 </dd>
249</dl>
250<dl class="section return"><dt>Returns</dt><dd>true if graph is Serialized to the Stream, false otherwise </dd></dl>
251
252<p class="definition">Definition at line <a class="el" href="_serializer_8cpp_source.html#l00050">50</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
253<div class="fragment"><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div>
254<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> pSerializerImpl-&gt;SaveSerializedToStream(stream);</div>
255<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
256</div><!-- fragment -->
257</div>
258</div>
259<a id="a4d146e96f4464192b762b23e1cf1e207"></a>
260<h2 class="memtitle"><span class="permalink"><a href="#a4d146e96f4464192b762b23e1cf1e207">&#9670;&nbsp;</a></span>Serialize()</h2>
261
262<div class="memitem">
263<div class="memproto">
264 <table class="memname">
265 <tr>
266 <td class="memname">void Serialize </td>
267 <td>(</td>
268 <td class="paramtype">const <a class="el" href="classarmnn_1_1_i_network.html">armnn::INetwork</a> &amp;&#160;</td>
269 <td class="paramname"><em>inNetwork</em></td><td>)</td>
270 <td></td>
271 </tr>
272 </table>
273</div><div class="memdoc">
274
275<p>Serializes the network to ArmNN SerializedGraph. </p>
276<dl class="params"><dt>Parameters</dt><dd>
277 <table class="params">
278 <tr><td class="paramdir">[in]</td><td class="paramname">inNetwork</td><td>The network to be serialized. </td></tr>
279 </table>
280 </dd>
281</dl>
282
283<p class="definition">Definition at line <a class="el" href="_serializer_8cpp_source.html#l00045">45</a> of file <a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a>.</p>
284<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div>
285<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; pSerializerImpl-&gt;Serialize(inNetwork);</div>
286<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
287</div><!-- fragment -->
288</div>
289</div>
290<hr/>The documentation for this class was generated from the following files:<ul>
291<li>include/armnnSerializer/<a class="el" href="_i_serializer_8hpp_source.html">ISerializer.hpp</a></li>
292<li>src/armnnSerializer/<a class="el" href="_serializer_8cpp_source.html">Serializer.cpp</a></li>
293</ul>
294</div><!-- contents -->
295</div><!-- doc-content -->
296<div class="ttc" id="aclassarmnn_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#l00040">Serializer.cpp:40</a></div></div>
297<div class="ttc" id="anamespacearmnn_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>
298<div class="ttc" id="aclassarmnn_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#l00030">Serializer.cpp:30</a></div></div>
299<div class="ttc" id="anamespacearmnn_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>
300<!-- start footer part -->
301<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
302 <ul>
303 <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>
304 <li class="footer">Generated on Thu May 16 2024 09:32:00 for Arm NN by
305 <a href="http://www.doxygen.org/index.html">
306 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
307 </ul>
308</div>
309</body>
310</html>