Few minor updates to BuildGuideAndroidNDK.md file
[platform/upstream/armnn.git] / Documentation / _caffe_parser_8cpp.xhtml
1 <!-- Copyright (c) 2020 ARM Limited. -->
2 <!--                                 -->
3 <!-- SPDX-License-Identifier: MIT    -->
4 <!--                                 -->
5 <!-- HTML header for doxygen 1.8.13-->
6 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7 <html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
11 <meta name="generator" content="Doxygen 1.8.13"/>
12 <meta name="robots" content="NOINDEX, NOFOLLOW" />
13 <meta name="viewport" content="width=device-width, initial-scale=1"/>
14 <title>ArmNN: src/armnnCaffeParser/CaffeParser.cpp File Reference</title>
15 <link href="tabs.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="jquery.js"></script>
17 <script type="text/javascript" src="dynsections.js"></script>
18 <link href="navtree.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="resize.js"></script>
20 <script type="text/javascript" src="navtreedata.js"></script>
21 <script type="text/javascript" src="navtree.js"></script>
22 <script type="text/javascript">
23   $(document).ready(initResizable);
24 </script>
25 <link href="search/search.css" rel="stylesheet" type="text/css"/>
26 <script type="text/javascript" src="search/searchdata.js"></script>
27 <script type="text/javascript" src="search/search.js"></script>
28 <script type="text/x-mathjax-config">
29   MathJax.Hub.Config({
30     extensions: ["tex2jax.js"],
31     jax: ["input/TeX","output/HTML-CSS"],
32 });
33 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34 <link href="doxygen.css" rel="stylesheet" type="text/css" />
35 <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36 </head>
37 <body>
38 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39 <div id="titlearea">
40 <table cellspacing="0" cellpadding="0">
41  <tbody>
42  <tr style="height: 56px;">
43   <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44   <td style="padding-left: 0.5em;">
45    <div id="projectname">
46    &#160;<span id="projectnumber">20.02</span>
47    </div>
48   </td>
49  </tr>
50  </tbody>
51 </table>
52 </div>
53 <!-- end header part -->
54 <!-- Generated by Doxygen 1.8.13 -->
55 <script type="text/javascript">
56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 </script>
58 <script type="text/javascript" src="menudata.js"></script>
59 <script type="text/javascript" src="menu.js"></script>
60 <script type="text/javascript">
61 $(function() {
62   initMenu('',true,false,'search.php','Search');
63   $(document).ready(function() { init_search(); });
64 });
65 </script>
66 <div id="main-nav"></div>
67 </div><!-- top -->
68 <div id="side-nav" class="ui-resizable side-nav-resizable">
69   <div id="nav-tree">
70     <div id="nav-tree-contents">
71       <div id="nav-sync" class="sync"></div>
72     </div>
73   </div>
74   <div id="splitbar" style="-moz-user-select:none;" 
75        class="ui-resizable-handle">
76   </div>
77 </div>
78 <script type="text/javascript">
79 $(document).ready(function(){initNavTree('_caffe_parser_8cpp.xhtml','');});
80 </script>
81 <div id="doc-content">
82 <!-- window showing the filter options -->
83 <div id="MSearchSelectWindow"
84      onmouseover="return searchBox.OnSearchSelectShow()"
85      onmouseout="return searchBox.OnSearchSelectHide()"
86      onkeydown="return searchBox.OnSearchSelectKey(event)">
87 </div>
88
89 <!-- iframe showing the search results (closed by default) -->
90 <div id="MSearchResultsWindow">
91 <iframe src="javascript:void(0)" frameborder="0" 
92         name="MSearchResults" id="MSearchResults">
93 </iframe>
94 </div>
95
96 <div class="header">
97   <div class="summary">
98 <a href="#namespaces">Namespaces</a> &#124;
99 <a href="#define-members">Macros</a> &#124;
100 <a href="#func-members">Functions</a>  </div>
101   <div class="headertitle">
102 <div class="title">CaffeParser.cpp File Reference</div>  </div>
103 </div><!--header-->
104 <div class="contents">
105 <div class="textblock"><code>#include &quot;<a class="el" href="_caffe_parser_8hpp_source.xhtml">CaffeParser.hpp</a>&quot;</code><br />
106 <code>#include &quot;<a class="el" href="_record_by_record_caffe_parser_8hpp_source.xhtml">RecordByRecordCaffeParser.hpp</a>&quot;</code><br />
107 <code>#include &quot;<a class="el" href="_descriptors_8hpp_source.xhtml">armnn/Descriptors.hpp</a>&quot;</code><br />
108 <code>#include &quot;<a class="el" href="_i_network_8hpp_source.xhtml">armnn/INetwork.hpp</a>&quot;</code><br />
109 <code>#include &quot;<a class="el" href="_utils_8hpp_source.xhtml">armnn/Utils.hpp</a>&quot;</code><br />
110 <code>#include &quot;<a class="el" href="_exceptions_8hpp_source.xhtml">armnn/Exceptions.hpp</a>&quot;</code><br />
111 <code>#include &quot;<a class="el" href="_graph_topological_sort_8hpp_source.xhtml">GraphTopologicalSort.hpp</a>&quot;</code><br />
112 <code>#include &quot;<a class="el" href="_verification_helpers_8hpp_source.xhtml">VerificationHelpers.hpp</a>&quot;</code><br />
113 <code>#include &lt;boost/numeric/conversion/cast.hpp&gt;</code><br />
114 <code>#include &lt;boost/assert.hpp&gt;</code><br />
115 <code>#include &lt;boost/format.hpp&gt;</code><br />
116 <code>#include &quot;caffe/proto/caffe.pb.h&quot;</code><br />
117 <code>#include &lt;google/protobuf/io/coded_stream.h&gt;</code><br />
118 <code>#include &lt;google/protobuf/io/zero_copy_stream.h&gt;</code><br />
119 <code>#include &lt;google/protobuf/io/zero_copy_stream_impl.h&gt;</code><br />
120 <code>#include &lt;google/protobuf/text_format.h&gt;</code><br />
121 <code>#include &lt;google/protobuf/stubs/common.h&gt;</code><br />
122 <code>#include &lt;google/protobuf/stubs/once.h&gt;</code><br />
123 <code>#include &lt;google/protobuf/descriptor.h&gt;</code><br />
124 <code>#include &lt;google/protobuf/generated_message_reflection.h&gt;</code><br />
125 <code>#include &lt;google/protobuf/reflection_ops.h&gt;</code><br />
126 <code>#include &lt;google/protobuf/wire_format.h&gt;</code><br />
127 <code>#include &lt;cmath&gt;</code><br />
128 <code>#include &lt;sstream&gt;</code><br />
129 <code>#include &lt;queue&gt;</code><br />
130 <code>#include &lt;fcntl.h&gt;</code><br />
131 </div>
132 <p><a href="_caffe_parser_8cpp_source.xhtml">Go to the source code of this file.</a></p>
133 <table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
135 Namespaces</h2></td></tr>
136 <tr class="memitem:namespacearmnn_caffe_parser"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_caffe_parser.xhtml">armnnCaffeParser</a></td></tr>
137 <tr class="memdesc:namespacearmnn_caffe_parser"><td class="mdescLeft">&#160;</td><td class="mdescRight">Caffe networks are loaded from protobuf files (binary or text) using the protobuf library and the generated code from caffe.pb.h. <br /></td></tr>
138 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 </table><table class="memberdecls">
140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
141 Macros</h2></td></tr>
142 <tr class="memitem:a7553d91772274ed9b103824bbf7f75a5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_caffe_parser_8cpp.xhtml#a7553d91772274ed9b103824bbf7f75a5">GET_OPTIONAL_WITH_VECTOR_FALLBACK</a>(PARAM,  PARAM_TYPE,  OPTIONAL_VALUE,  FALLBACK_VECTOR,  VALUE_TYPE,  DEFAULT_VALUE)</td></tr>
143 <tr class="separator:a7553d91772274ed9b103824bbf7f75a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a69f4a692d0095f6b19b0cd99cd75e465"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_caffe_parser_8cpp.xhtml#a69f4a692d0095f6b19b0cd99cd75e465">GET_OPTIONAL_WITH_FALLBACK</a>(PARAM,  PARAM_TYPE,  OPTIONAL_VALUE,  FALLBACK_VALUE,  VALUE_TYPE,  DEFAULT_VALUE)</td></tr>
145 <tr class="separator:a69f4a692d0095f6b19b0cd99cd75e465"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 </table><table class="memberdecls">
147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
148 Functions</h2></td></tr>
149 <tr class="memitem:af3fde7630e7c9df35cae9ed2b435dbed"><td class="memItemLeft" align="right" valign="top">BlobShape&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_caffe_parser.xhtml#af3fde7630e7c9df35cae9ed2b435dbed">TensorDescToBlobShape</a> (const <a class="el" href="classarmnn_1_1_tensor_info.xhtml">TensorInfo</a> &amp;desc)</td></tr>
150 <tr class="separator:af3fde7630e7c9df35cae9ed2b435dbed"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 </table>
152 <h2 class="groupheader">Macro Definition Documentation</h2>
153 <a id="a69f4a692d0095f6b19b0cd99cd75e465"></a>
154 <h2 class="memtitle"><span class="permalink"><a href="#a69f4a692d0095f6b19b0cd99cd75e465">&#9670;&nbsp;</a></span>GET_OPTIONAL_WITH_FALLBACK</h2>
155
156 <div class="memitem">
157 <div class="memproto">
158       <table class="memname">
159         <tr>
160           <td class="memname">#define GET_OPTIONAL_WITH_FALLBACK</td>
161           <td>(</td>
162           <td class="paramtype">&#160;</td>
163           <td class="paramname">PARAM, </td>
164         </tr>
165         <tr>
166           <td class="paramkey"></td>
167           <td></td>
168           <td class="paramtype">&#160;</td>
169           <td class="paramname">PARAM_TYPE, </td>
170         </tr>
171         <tr>
172           <td class="paramkey"></td>
173           <td></td>
174           <td class="paramtype">&#160;</td>
175           <td class="paramname">OPTIONAL_VALUE, </td>
176         </tr>
177         <tr>
178           <td class="paramkey"></td>
179           <td></td>
180           <td class="paramtype">&#160;</td>
181           <td class="paramname">FALLBACK_VALUE, </td>
182         </tr>
183         <tr>
184           <td class="paramkey"></td>
185           <td></td>
186           <td class="paramtype">&#160;</td>
187           <td class="paramname">VALUE_TYPE, </td>
188         </tr>
189         <tr>
190           <td class="paramkey"></td>
191           <td></td>
192           <td class="paramtype">&#160;</td>
193           <td class="paramname">DEFAULT_VALUE&#160;</td>
194         </tr>
195         <tr>
196           <td></td>
197           <td>)</td>
198           <td></td><td></td>
199         </tr>
200       </table>
201 </div><div class="memdoc">
202 <b>Value:</b><div class="fragment"><div class="line">GetOptionalWithFallback( \</div><div class="line">        PARAM, \</div><div class="line">        [](<span class="keyword">const</span> PARAM_TYPE &amp; param, VALUE_TYPE defaultValue) \</div><div class="line">        { \</div><div class="line">            if (param.has_##OPTIONAL_VALUE ()) \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">true</span>, param.OPTIONAL_VALUE ()); \</div><div class="line">            } \</div><div class="line">            else \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">false</span>, defaultValue); \</div><div class="line">            } \</div><div class="line">        }, \</div><div class="line">        [](<span class="keyword">const</span> PARAM_TYPE &amp; param, VALUE_TYPE defaultValue) \</div><div class="line">        { \</div><div class="line">            if (param.has_##FALLBACK_VALUE ()) \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">true</span>, param.FALLBACK_VALUE ()); \</div><div class="line">            } \</div><div class="line">            else \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">false</span>, defaultValue); \</div><div class="line">            } \</div><div class="line">        }, \</div><div class="line">        DEFAULT_VALUE)</div></div><!-- fragment -->
203 <p class="definition">Definition at line <a class="el" href="_caffe_parser_8cpp_source.xhtml#l00208">208</a> of file <a class="el" href="_caffe_parser_8cpp_source.xhtml">CaffeParser.cpp</a>.</p>
204
205 <p class="reference">Referenced by <a class="el" href="_caffe_parser_8cpp_source.xhtml#l00883">CaffeParserBase::ParsePoolingLayer()</a>.</p>
206
207 </div>
208 </div>
209 <a id="a7553d91772274ed9b103824bbf7f75a5"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#a7553d91772274ed9b103824bbf7f75a5">&#9670;&nbsp;</a></span>GET_OPTIONAL_WITH_VECTOR_FALLBACK</h2>
211
212 <div class="memitem">
213 <div class="memproto">
214       <table class="memname">
215         <tr>
216           <td class="memname">#define GET_OPTIONAL_WITH_VECTOR_FALLBACK</td>
217           <td>(</td>
218           <td class="paramtype">&#160;</td>
219           <td class="paramname">PARAM, </td>
220         </tr>
221         <tr>
222           <td class="paramkey"></td>
223           <td></td>
224           <td class="paramtype">&#160;</td>
225           <td class="paramname">PARAM_TYPE, </td>
226         </tr>
227         <tr>
228           <td class="paramkey"></td>
229           <td></td>
230           <td class="paramtype">&#160;</td>
231           <td class="paramname">OPTIONAL_VALUE, </td>
232         </tr>
233         <tr>
234           <td class="paramkey"></td>
235           <td></td>
236           <td class="paramtype">&#160;</td>
237           <td class="paramname">FALLBACK_VECTOR, </td>
238         </tr>
239         <tr>
240           <td class="paramkey"></td>
241           <td></td>
242           <td class="paramtype">&#160;</td>
243           <td class="paramname">VALUE_TYPE, </td>
244         </tr>
245         <tr>
246           <td class="paramkey"></td>
247           <td></td>
248           <td class="paramtype">&#160;</td>
249           <td class="paramname">DEFAULT_VALUE&#160;</td>
250         </tr>
251         <tr>
252           <td></td>
253           <td>)</td>
254           <td></td><td></td>
255         </tr>
256       </table>
257 </div><div class="memdoc">
258 <b>Value:</b><div class="fragment"><div class="line">GetOptionalWithFallback( \</div><div class="line">        PARAM, \</div><div class="line">        [](<span class="keyword">const</span> PARAM_TYPE &amp; param, VALUE_TYPE defaultValue) \</div><div class="line">        { \</div><div class="line">            if (param.has_##OPTIONAL_VALUE ()) \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">true</span>, param.OPTIONAL_VALUE ()); \</div><div class="line">            } \</div><div class="line">            else \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">false</span>, defaultValue); \</div><div class="line">            } \</div><div class="line">        }, \</div><div class="line">        [](<span class="keyword">const</span> PARAM_TYPE &amp; param, VALUE_TYPE defaultValue) \</div><div class="line">        { \</div><div class="line">            if (param.FALLBACK_VECTOR##_size() &gt; 0) \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">true</span>, (param.FALLBACK_VECTOR ()).Get(0)); \</div><div class="line">            } \</div><div class="line">            else \</div><div class="line">            { \</div><div class="line">                return std::make_pair(<span class="keyword">false</span>, defaultValue); \</div><div class="line">            } \</div><div class="line">        }, \</div><div class="line">        DEFAULT_VALUE)</div></div><!-- fragment -->
259 <p class="definition">Definition at line <a class="el" href="_caffe_parser_8cpp_source.xhtml#l00176">176</a> of file <a class="el" href="_caffe_parser_8cpp_source.xhtml">CaffeParser.cpp</a>.</p>
260
261 <p class="reference">Referenced by <a class="el" href="_caffe_parser_8cpp_source.xhtml#l00701">CaffeParserBase::ParseConvLayer()</a>.</p>
262
263 </div>
264 </div>
265 </div><!-- contents -->
266 </div><!-- doc-content -->
267 <!-- start footer part -->
268 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
269   <ul>
270     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_04760fd1fb320650b591e359d321263b.xhtml">armnnCaffeParser</a></li><li class="navelem"><a class="el" href="_caffe_parser_8cpp.xhtml">CaffeParser.cpp</a></li>
271     <li class="footer">Generated on Fri Mar 13 2020 16:09:14 for ArmNN by
272     <a href="http://www.doxygen.org/index.html">
273     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
274   </ul>
275 </div>
276 </body>
277 </html>