arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_multi_h_o_g.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: CLMultiHOG 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.05</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_c_l_multi_h_o_g.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">CLMultiHOG Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Basic implementation of the CL multi <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data-objects.  
126  <a href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_c_l_multi_h_o_g_8h_source.xhtml">CLMultiHOG.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for CLMultiHOG:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_multi_h_o_g__coll__graph.svg" width="112" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 </div>
134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137 Public Member Functions</h2></td></tr>
138 <tr class="memitem:a88dcfbbdb14ffc930e0f3e1eaf5b9d86"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#a88dcfbbdb14ffc930e0f3e1eaf5b9d86">CLMultiHOG</a> (size_t <a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#a63070a779573aae4282278bc08390329">num_models</a>)</td></tr>
139 <tr class="memdesc:a88dcfbbdb14ffc930e0f3e1eaf5b9d86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a88dcfbbdb14ffc930e0f3e1eaf5b9d86">More...</a><br /></td></tr>
140 <tr class="separator:a88dcfbbdb14ffc930e0f3e1eaf5b9d86"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a63070a779573aae4282278bc08390329"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#a63070a779573aae4282278bc08390329">num_models</a> () const override</td></tr>
142 <tr class="memdesc:a63070a779573aae4282278bc08390329"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> models stored.  <a href="#a63070a779573aae4282278bc08390329">More...</a><br /></td></tr>
143 <tr class="separator:a63070a779573aae4282278bc08390329"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a1a99e756de756c36ce69b206847725f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_h_o_g.xhtml">ICLHOG</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#a1a99e756de756c36ce69b206847725f8">cl_model</a> (size_t index) override</td></tr>
145 <tr class="memdesc:a1a99e756de756c36ce69b206847725f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the requested OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.  <a href="#a1a99e756de756c36ce69b206847725f8">More...</a><br /></td></tr>
146 <tr class="separator:a1a99e756de756c36ce69b206847725f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a33d093c2031c097bc740f8b6c76165ca"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_i_c_l_h_o_g.xhtml">ICLHOG</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml#a33d093c2031c097bc740f8b6c76165ca">cl_model</a> (size_t index) const override</td></tr>
148 <tr class="memdesc:a33d093c2031c097bc740f8b6c76165ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant pointer to the requested OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.  <a href="#a33d093c2031c097bc740f8b6c76165ca">More...</a><br /></td></tr>
149 <tr class="separator:a33d093c2031c097bc740f8b6c76165ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_multi_h_o_g.xhtml">ICLMultiHOG</a></td></tr>
151 <tr class="memitem:aa9d93a19f9961a4ee8b06527cd8842b4 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_h_o_g.xhtml">IHOG</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_h_o_g.xhtml#aa9d93a19f9961a4ee8b06527cd8842b4">model</a> (size_t index) override</td></tr>
152 <tr class="memdesc:aa9d93a19f9961a4ee8b06527cd8842b4 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the requested <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.  <a href="#aa9d93a19f9961a4ee8b06527cd8842b4">More...</a><br /></td></tr>
153 <tr class="separator:aa9d93a19f9961a4ee8b06527cd8842b4 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:a3fdc663dd36acddc50a879d9b2f84d2a inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_i_h_o_g.xhtml">IHOG</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_h_o_g.xhtml#a3fdc663dd36acddc50a879d9b2f84d2a">model</a> (size_t index) const override</td></tr>
155 <tr class="memdesc:a3fdc663dd36acddc50a879d9b2f84d2a inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a const pointer to the requested <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.  <a href="#a3fdc663dd36acddc50a879d9b2f84d2a">More...</a><br /></td></tr>
156 <tr class="separator:a3fdc663dd36acddc50a879d9b2f84d2a inherit pub_methods_classarm__compute_1_1_i_c_l_multi_h_o_g"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_multi_h_o_g"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_multi_h_o_g')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_multi_h_o_g.xhtml">IMultiHOG</a></td></tr>
158 <tr class="memitem:a6698fe6d38d2bb18553ae37a5d1aa42c inherit pub_methods_classarm__compute_1_1_i_multi_h_o_g"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_multi_h_o_g.xhtml#a6698fe6d38d2bb18553ae37a5d1aa42c">~IMultiHOG</a> ()=default</td></tr>
159 <tr class="memdesc:a6698fe6d38d2bb18553ae37a5d1aa42c inherit pub_methods_classarm__compute_1_1_i_multi_h_o_g"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a6698fe6d38d2bb18553ae37a5d1aa42c">More...</a><br /></td></tr>
160 <tr class="separator:a6698fe6d38d2bb18553ae37a5d1aa42c inherit pub_methods_classarm__compute_1_1_i_multi_h_o_g"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
163 <div class="textblock"><p>Basic implementation of the CL multi <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data-objects. </p>
164
165 <p>Definition at line <a class="el" href="_c_l_multi_h_o_g_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_c_l_multi_h_o_g_8h_source.xhtml">CLMultiHOG.h</a>.</p>
166 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
167 <a class="anchor" id="a88dcfbbdb14ffc930e0f3e1eaf5b9d86"></a>
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_multi_h_o_g.xhtml">CLMultiHOG</a> </td>
173           <td>(</td>
174           <td class="paramtype">size_t&#160;</td>
175           <td class="paramname"><em>num_models</em></td><td>)</td>
176           <td></td>
177         </tr>
178       </table>
179 </div><div class="memdoc">
180
181 <p>Constructor. </p>
182 <dl class="params"><dt>Parameters</dt><dd>
183   <table class="params">
184     <tr><td class="paramdir">[in]</td><td class="paramname">num_models</td><td>Number of <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data objects to contain </td></tr>
185   </table>
186   </dd>
187 </dl>
188
189 </div>
190 </div>
191 <h2 class="groupheader">Member Function Documentation</h2>
192 <a class="anchor" id="a1a99e756de756c36ce69b206847725f8"></a>
193 <div class="memitem">
194 <div class="memproto">
195 <table class="mlabels">
196   <tr>
197   <td class="mlabels-left">
198       <table class="memname">
199         <tr>
200           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_h_o_g.xhtml">ICLHOG</a>* cl_model </td>
201           <td>(</td>
202           <td class="paramtype">size_t&#160;</td>
203           <td class="paramname"><em>index</em></td><td>)</td>
204           <td></td>
205         </tr>
206       </table>
207   </td>
208   <td class="mlabels-right">
209 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
210   </tr>
211 </table>
212 </div><div class="memdoc">
213
214 <p>Return a pointer to the requested OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model. </p>
215 <dl class="params"><dt>Parameters</dt><dd>
216   <table class="params">
217     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.</td></tr>
218   </table>
219   </dd>
220 </dl>
221 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model </dd></dl>
222
223 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_multi_h_o_g.xhtml#a5ae9e122f1b39908b8602cc0acc035c8">ICLMultiHOG</a>.</p>
224
225 </div>
226 </div>
227 <a class="anchor" id="a33d093c2031c097bc740f8b6c76165ca"></a>
228 <div class="memitem">
229 <div class="memproto">
230 <table class="mlabels">
231   <tr>
232   <td class="mlabels-left">
233       <table class="memname">
234         <tr>
235           <td class="memname">const <a class="el" href="classarm__compute_1_1_i_c_l_h_o_g.xhtml">ICLHOG</a>* cl_model </td>
236           <td>(</td>
237           <td class="paramtype">size_t&#160;</td>
238           <td class="paramname"><em>index</em></td><td>)</td>
239           <td> const</td>
240         </tr>
241       </table>
242   </td>
243   <td class="mlabels-right">
244 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
245   </tr>
246 </table>
247 </div><div class="memdoc">
248
249 <p>Return a constant pointer to the requested OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model. </p>
250 <dl class="params"><dt>Parameters</dt><dd>
251   <table class="params">
252     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model.</td></tr>
253   </table>
254   </dd>
255 </dl>
256 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the OpenCL <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> model </dd></dl>
257
258 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_multi_h_o_g.xhtml#aec23164646e42c512d783eda60017f7e">ICLMultiHOG</a>.</p>
259
260 </div>
261 </div>
262 <a class="anchor" id="a63070a779573aae4282278bc08390329"></a>
263 <div class="memitem">
264 <div class="memproto">
265 <table class="mlabels">
266   <tr>
267   <td class="mlabels-left">
268       <table class="memname">
269         <tr>
270           <td class="memname">size_t num_models </td>
271           <td>(</td>
272           <td class="paramname"></td><td>)</td>
273           <td> const</td>
274         </tr>
275       </table>
276   </td>
277   <td class="mlabels-right">
278 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
279   </tr>
280 </table>
281 </div><div class="memdoc">
282
283 <p>The number of <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> models stored. </p>
284 <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> models stored </dd></dl>
285
286 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_h_o_g.xhtml#a36ab43f5c3606001dcd2468b955f3e02">IMultiHOG</a>.</p>
287
288 </div>
289 </div>
290 <hr/>The documentation for this class was generated from the following file:<ul>
291 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_multi_h_o_g_8h_source.xhtml">CLMultiHOG.h</a></li>
292 </ul>
293 </div><!-- contents -->
294 </div><!-- doc-content -->
295 <!-- start footer part -->
296 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
297   <ul>
298     <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_c_l_multi_h_o_g.xhtml">CLMultiHOG</a></li>
299     <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
300     <a href="http://www.doxygen.org/index.html">
301     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
302   </ul>
303 </div>
304 </body>
305 </html>