documentation/classarm__compute_1_1_weights_info.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: WeightsInfo 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 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.03</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_weights_info.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">WeightsInfo Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Convolution Layer Weights Information class.
 126  <a href="classarm__compute_1_1_weights_info.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:a8bf46ce65f0f9cc0210774dfc60b4e2f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_weights_info.xhtml#a8bf46ce65f0f9cc0210774dfc60b4e2f">WeightsInfo</a> ()</td></tr>
 133 <tr class="memdesc:a8bf46ce65f0f9cc0210774dfc60b4e2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a8bf46ce65f0f9cc0210774dfc60b4e2f">More...</a><br /></td></tr>
 134 <tr class="separator:a8bf46ce65f0f9cc0210774dfc60b4e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a7af92b099af871d8143ded96ce4f0b28"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_weights_info.xhtml#a7af92b099af871d8143ded96ce4f0b28">WeightsInfo</a> (bool <a class="el" href="classarm__compute_1_1_weights_info.xhtml#a5bfccf416ebb3979b4dca9a6ff6be5e0">are_reshaped</a>, unsigned int kernel_width, unsigned int kernel_height, unsigned int <a class="el" href="classarm__compute_1_1_weights_info.xhtml#ae56950468898173b9466ab93b843c967">num_kernels</a>)</td></tr>
 136 <tr class="memdesc:a7af92b099af871d8143ded96ce4f0b28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7af92b099af871d8143ded96ce4f0b28">More...</a><br /></td></tr>
 137 <tr class="separator:a7af92b099af871d8143ded96ce4f0b28"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a5bfccf416ebb3979b4dca9a6ff6be5e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_weights_info.xhtml#a5bfccf416ebb3979b4dca9a6ff6be5e0">are_reshaped</a> () const </td></tr>
 139 <tr class="memdesc:a5bfccf416ebb3979b4dca9a6ff6be5e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag which specifies if the weights tensor has been reshaped.  <a href="#a5bfccf416ebb3979b4dca9a6ff6be5e0">More...</a><br /></td></tr>
 140 <tr class="separator:a5bfccf416ebb3979b4dca9a6ff6be5e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ae56950468898173b9466ab93b843c967"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_weights_info.xhtml#ae56950468898173b9466ab93b843c967">num_kernels</a> () const </td></tr>
 142 <tr class="memdesc:ae56950468898173b9466ab93b843c967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of convolution kernels.  <a href="#ae56950468898173b9466ab93b843c967">More...</a><br /></td></tr>
 143 <tr class="separator:ae56950468898173b9466ab93b843c967"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a6da544d7a9bf5fe4114e55ddd198dbcc"><td class="memItemLeft" align="right" valign="top">std::pair&lt; unsigned int, unsigned int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_weights_info.xhtml#a6da544d7a9bf5fe4114e55ddd198dbcc">kernel_size</a> () const </td></tr>
 145 <tr class="memdesc:a6da544d7a9bf5fe4114e55ddd198dbcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the width and height of the kernel.  <a href="#a6da544d7a9bf5fe4114e55ddd198dbcc">More...</a><br /></td></tr>
 146 <tr class="separator:a6da544d7a9bf5fe4114e55ddd198dbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table>
 148 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 149 <div class="textblock"><p>Convolution Layer Weights Information class. </p>
 150 <p>This class stores the necessary information to compute convolution layer when the weights are already reshaped </p>
 151
 152 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00825">825</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 153 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 154 <a class="anchor" id="a8bf46ce65f0f9cc0210774dfc60b4e2f"></a>
 155 <div class="memitem">
 156 <div class="memproto">
 157 <table class="mlabels">
 158   <tr>
 159   <td class="mlabels-left">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname"><a class="el" href="classarm__compute_1_1_weights_info.xhtml">WeightsInfo</a> </td>
 163           <td>(</td>
 164           <td class="paramname"></td><td>)</td>
 165           <td></td>
 166         </tr>
 167       </table>
 168   </td>
 169   <td class="mlabels-right">
 170 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 171   </tr>
 172 </table>
 173 </div><div class="memdoc">
 174
 175 <p>Default constructor. </p>
 176
 177 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00829">829</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 178 <div class="fragment"><div class="line"><a name="l00830"></a><span class="lineno">  830</span>&#160;        : _are_reshaped(<span class="keyword">false</span>), _kernel_width(0), _kernel_height(0), _num_kernels(0)</div><div class="line"><a name="l00831"></a><span class="lineno">  831</span>&#160;    {</div><div class="line"><a name="l00832"></a><span class="lineno">  832</span>&#160;    }</div></div><!-- fragment -->
 179 </div>
 180 </div>
 181 <a class="anchor" id="a7af92b099af871d8143ded96ce4f0b28"></a>
 182 <div class="memitem">
 183 <div class="memproto">
 184 <table class="mlabels">
 185   <tr>
 186   <td class="mlabels-left">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname"><a class="el" href="classarm__compute_1_1_weights_info.xhtml">WeightsInfo</a> </td>
 190           <td>(</td>
 191           <td class="paramtype">bool&#160;</td>
 192           <td class="paramname"><em>are_reshaped</em>, </td>
 193         </tr>
 194         <tr>
 195           <td class="paramkey"></td>
 196           <td></td>
 197           <td class="paramtype">unsigned int&#160;</td>
 198           <td class="paramname"><em>kernel_width</em>, </td>
 199         </tr>
 200         <tr>
 201           <td class="paramkey"></td>
 202           <td></td>
 203           <td class="paramtype">unsigned int&#160;</td>
 204           <td class="paramname"><em>kernel_height</em>, </td>
 205         </tr>
 206         <tr>
 207           <td class="paramkey"></td>
 208           <td></td>
 209           <td class="paramtype">unsigned int&#160;</td>
 210           <td class="paramname"><em>num_kernels</em>&#160;</td>
 211         </tr>
 212         <tr>
 213           <td></td>
 214           <td>)</td>
 215           <td></td><td></td>
 216         </tr>
 217       </table>
 218   </td>
 219   <td class="mlabels-right">
 220 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 221   </tr>
 222 </table>
 223 </div><div class="memdoc">
 224
 225 <p>Constructor. </p>
 226 <dl class="params"><dt>Parameters</dt><dd>
 227   <table class="params">
 228     <tr><td class="paramdir">[in]</td><td class="paramname">are_reshaped</td><td>True if the weights have been reshaped </td></tr>
 229     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_width</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> width. </td></tr>
 230     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_height</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> height. </td></tr>
 231     <tr><td class="paramdir">[in]</td><td class="paramname">num_kernels</td><td>Number of convolution kernels. </td></tr>
 232   </table>
 233   </dd>
 234 </dl>
 235
 236 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00840">840</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 237 <div class="fragment"><div class="line"><a name="l00841"></a><span class="lineno">  841</span>&#160;        : _are_reshaped(<a class="code" href="classarm__compute_1_1_weights_info.xhtml#a5bfccf416ebb3979b4dca9a6ff6be5e0">are_reshaped</a>), _kernel_width(kernel_width), _kernel_height(kernel_height), _num_kernels(<a class="code" href="classarm__compute_1_1_weights_info.xhtml#ae56950468898173b9466ab93b843c967">num_kernels</a>)</div><div class="line"><a name="l00842"></a><span class="lineno">  842</span>&#160;    {</div><div class="line"><a name="l00843"></a><span class="lineno">  843</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_weights_info_xhtml_a5bfccf416ebb3979b4dca9a6ff6be5e0"><div class="ttname"><a href="classarm__compute_1_1_weights_info.xhtml#a5bfccf416ebb3979b4dca9a6ff6be5e0">arm_compute::WeightsInfo::are_reshaped</a></div><div class="ttdeci">bool are_reshaped() const </div><div class="ttdoc">Flag which specifies if the weights tensor has been reshaped. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00848">Types.h:848</a></div></div>
 238 <div class="ttc" id="classarm__compute_1_1_weights_info_xhtml_ae56950468898173b9466ab93b843c967"><div class="ttname"><a href="classarm__compute_1_1_weights_info.xhtml#ae56950468898173b9466ab93b843c967">arm_compute::WeightsInfo::num_kernels</a></div><div class="ttdeci">unsigned int num_kernels() const </div><div class="ttdoc">Return the number of convolution kernels. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00856">Types.h:856</a></div></div>
 239 </div><!-- fragment -->
 240 </div>
 241 </div>
 242 <h2 class="groupheader">Member Function Documentation</h2>
 243 <a class="anchor" id="a5bfccf416ebb3979b4dca9a6ff6be5e0"></a>
 244 <div class="memitem">
 245 <div class="memproto">
 246 <table class="mlabels">
 247   <tr>
 248   <td class="mlabels-left">
 249       <table class="memname">
 250         <tr>
 251           <td class="memname">bool are_reshaped </td>
 252           <td>(</td>
 253           <td class="paramname"></td><td>)</td>
 254           <td> const</td>
 255         </tr>
 256       </table>
 257   </td>
 258   <td class="mlabels-right">
 259 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 260   </tr>
 261 </table>
 262 </div><div class="memdoc">
 263
 264 <p>Flag which specifies if the weights tensor has been reshaped. </p>
 265 <dl class="section return"><dt>Returns</dt><dd>True if the weights tensors has been reshaped </dd></dl>
 266
 267 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00848">848</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 268
 269 <p>Referenced by <a class="el" href="_type_printer_8h_source.xhtml#l00142">arm_compute::operator&lt;&lt;()</a>.</p>
 270 <div class="fragment"><div class="line"><a name="l00849"></a><span class="lineno">  849</span>&#160;    {</div><div class="line"><a name="l00850"></a><span class="lineno">  850</span>&#160;        <span class="keywordflow">return</span> _are_reshaped;</div><div class="line"><a name="l00851"></a><span class="lineno">  851</span>&#160;    };</div></div><!-- fragment -->
 271 </div>
 272 </div>
 273 <a class="anchor" id="a6da544d7a9bf5fe4114e55ddd198dbcc"></a>
 274 <div class="memitem">
 275 <div class="memproto">
 276 <table class="mlabels">
 277   <tr>
 278   <td class="mlabels-left">
 279       <table class="memname">
 280         <tr>
 281           <td class="memname">std::pair&lt;unsigned int, unsigned int&gt; kernel_size </td>
 282           <td>(</td>
 283           <td class="paramname"></td><td>)</td>
 284           <td> const</td>
 285         </tr>
 286       </table>
 287   </td>
 288   <td class="mlabels-right">
 289 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 290   </tr>
 291 </table>
 292 </div><div class="memdoc">
 293
 294 <p>Return the width and height of the kernel. </p>
 295 <dl class="section return"><dt>Returns</dt><dd>The width and height of the kernel </dd></dl>
 296
 297 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00864">864</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 298
 299 <p>Referenced by <a class="el" href="_type_printer_8h_source.xhtml#l00142">arm_compute::operator&lt;&lt;()</a>.</p>
 300 <div class="fragment"><div class="line"><a name="l00865"></a><span class="lineno">  865</span>&#160;    {</div><div class="line"><a name="l00866"></a><span class="lineno">  866</span>&#160;        <span class="keywordflow">return</span> std::make_pair(_kernel_width, _kernel_height);</div><div class="line"><a name="l00867"></a><span class="lineno">  867</span>&#160;    }</div></div><!-- fragment -->
 301 </div>
 302 </div>
 303 <a class="anchor" id="ae56950468898173b9466ab93b843c967"></a>
 304 <div class="memitem">
 305 <div class="memproto">
 306 <table class="mlabels">
 307   <tr>
 308   <td class="mlabels-left">
 309       <table class="memname">
 310         <tr>
 311           <td class="memname">unsigned int num_kernels </td>
 312           <td>(</td>
 313           <td class="paramname"></td><td>)</td>
 314           <td> const</td>
 315         </tr>
 316       </table>
 317   </td>
 318   <td class="mlabels-right">
 319 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 320   </tr>
 321 </table>
 322 </div><div class="memdoc">
 323
 324 <p>Return the number of convolution kernels. </p>
 325 <dl class="section return"><dt>Returns</dt><dd>The number of convolution kernels </dd></dl>
 326
 327 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00856">856</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 328
 329 <p>Referenced by <a class="el" href="_type_printer_8h_source.xhtml#l00142">arm_compute::operator&lt;&lt;()</a>.</p>
 330 <div class="fragment"><div class="line"><a name="l00857"></a><span class="lineno">  857</span>&#160;    {</div><div class="line"><a name="l00858"></a><span class="lineno">  858</span>&#160;        <span class="keywordflow">return</span> _num_kernels;</div><div class="line"><a name="l00859"></a><span class="lineno">  859</span>&#160;    };</div></div><!-- fragment -->
 331 </div>
 332 </div>
 333 <hr/>The documentation for this class was generated from the following file:<ul>
 334 <li>arm_compute/core/<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a></li>
 335 </ul>
 336 </div><!-- contents -->
 337 </div><!-- doc-content -->
 338 <!-- start footer part -->
 339 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 340   <ul>
 341     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_weights_info.xhtml">WeightsInfo</a></li>
 342     <li class="footer">Generated on Fri Mar 2 2018 12:37:59 for Compute Library by
 343     <a href="http://www.doxygen.org/index.html">
 344     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 345   </ul>
 346 </div>
 347 </body>
 348 </html>