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">
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: Pyramid 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.04</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main 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 Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_pyramid.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">Pyramid Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic implementation of the pyramid interface.
125 <a href="classarm__compute_1_1_pyramid.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for Pyramid:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_pyramid__coll__graph.svg" width="86" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:ae4e11cca76492d63009564d1ea466dff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#ae4e11cca76492d63009564d1ea466dff">init</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &<a class="el" href="classarm__compute_1_1_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
138 <tr class="memdesc:ae4e11cca76492d63009564d1ea466dff"><td class="mdescLeft"> </td><td class="mdescRight">Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. <a href="#ae4e11cca76492d63009564d1ea466dff">More...</a><br /></td></tr>
139 <tr class="separator:ae4e11cca76492d63009564d1ea466dff"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a0dd473fd109df68b4747ebf0f586a115"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#a0dd473fd109df68b4747ebf0f586a115">init_auto_padding</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &<a class="el" href="classarm__compute_1_1_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
141 <tr class="memdesc:a0dd473fd109df68b4747ebf0f586a115"><td class="mdescLeft"> </td><td class="mdescRight">Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. <a href="#a0dd473fd109df68b4747ebf0f586a115">More...</a><br /></td></tr>
142 <tr class="separator:a0dd473fd109df68b4747ebf0f586a115"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#acaefe811b78a2fdc4a0dba0c4029c3ef">allocate</a> ()</td></tr>
144 <tr class="memdesc:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the planes in the pyramid. <a href="#acaefe811b78a2fdc4a0dba0c4029c3ef">More...</a><br /></td></tr>
145 <tr class="separator:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ac1b010c3c67886aa4add531ed3bbceac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a> () const override</td></tr>
147 <tr class="memdesc:ac1b010c3c67886aa4add531ed3bbceac"><td class="mdescLeft"> </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="#ac1b010c3c67886aa4add531ed3bbceac">More...</a><br /></td></tr>
148 <tr class="separator:ac1b010c3c67886aa4add531ed3bbceac"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:a4187fb90f552249901da9febb67d8b7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#a4187fb90f552249901da9febb67d8b7a">get_pyramid_level</a> (size_t index) const override</td></tr>
150 <tr class="memdesc:a4187fb90f552249901da9febb67d8b7a"><td class="mdescLeft"> </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="#a4187fb90f552249901da9febb67d8b7a">More...</a><br /></td></tr>
151 <tr class="separator:a4187fb90f552249901da9febb67d8b7a"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_pyramid"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_pyramid')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml">IPyramid</a></td></tr>
153 <tr class="memitem:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a2925d59af502d059fcb2326a6ada7867">~IPyramid</a> ()=default</td></tr>
154 <tr class="memdesc:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a2925d59af502d059fcb2326a6ada7867">More...</a><br /></td></tr>
155 <tr class="separator:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="memSeparator" colspan="2"> </td></tr>
157 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
158 <div class="textblock"><p>Basic implementation of the pyramid interface. </p>
160 <p>Definition at line <a class="el" href="_pyramid_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a>.</p>
161 </div><h2 class="groupheader">Member Function Documentation</h2>
162 <a class="anchor" id="acaefe811b78a2fdc4a0dba0c4029c3ef"></a>
163 <div class="memitem">
164 <div class="memproto">
165 <table class="memname">
167 <td class="memname">void allocate </td>
169 <td class="paramname"></td><td>)</td>
173 </div><div class="memdoc">
175 <p>Allocate the planes in the pyramid. </p>
179 <a class="anchor" id="a4187fb90f552249901da9febb67d8b7a"></a>
180 <div class="memitem">
181 <div class="memproto">
182 <table class="mlabels">
184 <td class="mlabels-left">
185 <table class="memname">
187 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a>* get_pyramid_level </td>
189 <td class="paramtype">size_t </td>
190 <td class="paramname"><em>index</em></td><td>)</td>
195 <td class="mlabels-right">
196 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
199 </div><div class="memdoc">
201 <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>
202 <dl class="params"><dt>Parameters</dt><dd>
203 <table class="params">
204 <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>
208 <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>
210 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a11ab83492962adab883cb1d0fbdd7af6">IPyramid</a>.</p>
214 <a class="anchor" id="ac1b010c3c67886aa4add531ed3bbceac"></a>
215 <div class="memitem">
216 <div class="memproto">
217 <table class="mlabels">
219 <td class="mlabels-left">
220 <table class="memname">
222 <td class="memname">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>* info </td>
224 <td class="paramname"></td><td>)</td>
229 <td class="mlabels-right">
230 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
233 </div><div class="memdoc">
235 <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>
236 <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>
238 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a7114241d28b1d2ebb7b9dba9f1ab0c8b">IPyramid</a>.</p>
242 <a class="anchor" id="ae4e11cca76492d63009564d1ea466dff"></a>
243 <div class="memitem">
244 <div class="memproto">
245 <table class="memname">
247 <td class="memname">void init </td>
249 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> & </td>
250 <td class="paramname"><em>info</em></td><td>)</td>
254 </div><div class="memdoc">
256 <p>Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
257 <dl class="params"><dt>Parameters</dt><dd>
258 <table class="params">
259 <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata </td></tr>
266 <a class="anchor" id="a0dd473fd109df68b4747ebf0f586a115"></a>
267 <div class="memitem">
268 <div class="memproto">
269 <table class="memname">
271 <td class="memname">void init_auto_padding </td>
273 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> & </td>
274 <td class="paramname"><em>info</em></td><td>)</td>
278 </div><div class="memdoc">
280 <p>Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
281 <dl class="section note"><dt>Note</dt><dd>Uses conservative padding strategy which fits all kernels.</dd></dl>
282 <dl class="params"><dt>Parameters</dt><dd>
283 <table class="params">
284 <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata </td></tr>
291 <hr/>The documentation for this class was generated from the following file:<ul>
292 <li>arm_compute/runtime/<a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a></li>
294 </div><!-- contents -->
295 </div><!-- doc-content -->
296 <!-- start footer part -->
297 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
299 <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_pyramid.xhtml">Pyramid</a></li>
300 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
301 <a href="http://www.doxygen.org/index.html">
302 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>