documentation/classarm__compute_1_1_i_pyramid.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>ARM Compute Library: IPyramid 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_pyramid.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">IPyramid Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Interface for pyramid data-object.
 125  <a href="classarm__compute_1_1_i_pyramid.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_i_pyramid_8h_source.xhtml">IPyramid.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 130 Public Member Functions</h2></td></tr>
 131 <tr class="memitem:a2925d59af502d059fcb2326a6ada7867"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a2925d59af502d059fcb2326a6ada7867">~IPyramid</a> ()=default</td></tr>
 132 <tr class="memdesc:a2925d59af502d059fcb2326a6ada7867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a2925d59af502d059fcb2326a6ada7867">More...</a><br /></td></tr>
 133 <tr class="separator:a2925d59af502d059fcb2326a6ada7867"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:a7114241d28b1d2ebb7b9dba9f1ab0c8b"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a7114241d28b1d2ebb7b9dba9f1ab0c8b">info</a> () const =0</td></tr>
 135 <tr class="memdesc:a7114241d28b1d2ebb7b9dba9f1ab0c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata.  <a href="#a7114241d28b1d2ebb7b9dba9f1ab0c8b">More...</a><br /></td></tr>
 136 <tr class="separator:a7114241d28b1d2ebb7b9dba9f1ab0c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:a11ab83492962adab883cb1d0fbdd7af6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a11ab83492962adab883cb1d0fbdd7af6">get_pyramid_level</a> (size_t index) const =0</td></tr>
 138 <tr class="memdesc:a11ab83492962adab883cb1d0fbdd7af6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a level of the pyramid as a <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer.  <a href="#a11ab83492962adab883cb1d0fbdd7af6">More...</a><br /></td></tr>
 139 <tr class="separator:a11ab83492962adab883cb1d0fbdd7af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 </table>
 141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 142 <div class="textblock"><p>Interface for pyramid data-object. </p>
 143
 144 <p>Definition at line <a class="el" href="_i_pyramid_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_i_pyramid_8h_source.xhtml">IPyramid.h</a>.</p>
 145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 146 <a class="anchor" id="a2925d59af502d059fcb2326a6ada7867"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_pyramid.xhtml">IPyramid</a> </td>
 155           <td>(</td>
 156           <td class="paramname"></td><td>)</td>
 157           <td></td>
 158         </tr>
 159       </table>
 160   </td>
 161   <td class="mlabels-right">
 162 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 163   </tr>
 164 </table>
 165 </div><div class="memdoc">
 166
 167 <p>Default virtual destructor. </p>
 168
 169 </div>
 170 </div>
 171 <h2 class="groupheader">Member Function Documentation</h2>
 172 <a class="anchor" id="a11ab83492962adab883cb1d0fbdd7af6"></a>
 173 <div class="memitem">
 174 <div class="memproto">
 175 <table class="mlabels">
 176   <tr>
 177   <td class="mlabels-left">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">virtual <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a>* get_pyramid_level </td>
 181           <td>(</td>
 182           <td class="paramtype">size_t&#160;</td>
 183           <td class="paramname"><em>index</em></td><td>)</td>
 184           <td> const</td>
 185         </tr>
 186       </table>
 187   </td>
 188   <td class="mlabels-right">
 189 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 190   </tr>
 191 </table>
 192 </div><div class="memdoc">
 193
 194 <p>Retrieves a level of the pyramid as a <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer. </p>
 195 <dl class="params"><dt>Parameters</dt><dd>
 196   <table class="params">
 197     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the level, such that index is less than levels.</td></tr>
 198   </table>
 199   </dd>
 200 </dl>
 201 <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer </dd></dl>
 202
 203 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#af07bb423a5c0df8018b67c0e94fada02">CLPyramid</a>, and <a class="el" href="classarm__compute_1_1_pyramid.xhtml#a4187fb90f552249901da9febb67d8b7a">Pyramid</a>.</p>
 204
 205 </div>
 206 </div>
 207 <a class="anchor" id="a7114241d28b1d2ebb7b9dba9f1ab0c8b"></a>
 208 <div class="memitem">
 209 <div class="memproto">
 210 <table class="mlabels">
 211   <tr>
 212   <td class="mlabels-left">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">virtual const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>* info </td>
 216           <td>(</td>
 217           <td class="paramname"></td><td>)</td>
 218           <td> const</td>
 219         </tr>
 220       </table>
 221   </td>
 222   <td class="mlabels-right">
 223 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 224   </tr>
 225 </table>
 226 </div><div class="memdoc">
 227
 228 <p>Interface to be implemented by the child class to return the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
 229 <dl class="section return"><dt>Returns</dt><dd>A pointer to the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </dd></dl>
 230
 231 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">CLPyramid</a>, and <a class="el" href="classarm__compute_1_1_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">Pyramid</a>.</p>
 232
 233 </div>
 234 </div>
 235 <hr/>The documentation for this class was generated from the following file:<ul>
 236 <li>arm_compute/core/<a class="el" href="_i_pyramid_8h_source.xhtml">IPyramid.h</a></li>
 237 </ul>
 238 </div><!-- contents -->
 239 </div><!-- doc-content -->
 240 <!-- start footer part -->
 241 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 242   <ul>
 243     <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_i_pyramid.xhtml">IPyramid</a></li>
 244     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 245     <a href="http://www.doxygen.org/index.html">
 246     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 247   </ul>
 248 </div>
 249 </body>
 250 </html>