arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_sobel5x5_vert_kernel.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: NESobel5x5VertKernel 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_n_e_sobel5x5_vert_kernel.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">NESobel5x5VertKernel Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for the kernel to run the vertical pass of 5x5 Sobel Y filter on a tensor.  
126  <a href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml">NESobel5x5Kernel.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for NESobel5x5VertKernel:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_sobel5x5_vert_kernel__coll__graph.svg" width="175" 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:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
139 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
140 <tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ab46cf54e2df5a20b634660a06e48e9d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#ab46cf54e2df5a20b634660a06e48e9d5">NESobel5x5VertKernel</a> ()</td></tr>
142 <tr class="memdesc:ab46cf54e2df5a20b634660a06e48e9d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ab46cf54e2df5a20b634660a06e48e9d5">More...</a><br /></td></tr>
143 <tr class="separator:ab46cf54e2df5a20b634660a06e48e9d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:aefe5ee52a24df017a67c5fe79ac0d19f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#aefe5ee52a24df017a67c5fe79ac0d19f">NESobel5x5VertKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:aefe5ee52a24df017a67c5fe79ac0d19f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#aefe5ee52a24df017a67c5fe79ac0d19f">More...</a><br /></td></tr>
146 <tr class="separator:aefe5ee52a24df017a67c5fe79ac0d19f"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a8954c998e67758f56891caf8da30c953"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a8954c998e67758f56891caf8da30c953">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;)=delete</td></tr>
148 <tr class="memdesc:a8954c998e67758f56891caf8da30c953"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a8954c998e67758f56891caf8da30c953">More...</a><br /></td></tr>
149 <tr class="separator:a8954c998e67758f56891caf8da30c953"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a2ff0db37338bc4f3cbc18e51ce0317ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a2ff0db37338bc4f3cbc18e51ce0317ae">NESobel5x5VertKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&amp;)=default</td></tr>
151 <tr class="memdesc:a2ff0db37338bc4f3cbc18e51ce0317ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a2ff0db37338bc4f3cbc18e51ce0317ae">More...</a><br /></td></tr>
152 <tr class="separator:a2ff0db37338bc4f3cbc18e51ce0317ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a59d1a2b1ef3d2b7e3bc5e942714d102a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a59d1a2b1ef3d2b7e3bc5e942714d102a">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&amp;)=default</td></tr>
154 <tr class="memdesc:a59d1a2b1ef3d2b7e3bc5e942714d102a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a59d1a2b1ef3d2b7e3bc5e942714d102a">More...</a><br /></td></tr>
155 <tr class="separator:a59d1a2b1ef3d2b7e3bc5e942714d102a"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:af8c29da1f0b11bd359b1574fbf86c1c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#af8c29da1f0b11bd359b1574fbf86c1c8">~NESobel5x5VertKernel</a> ()=default</td></tr>
157 <tr class="memdesc:af8c29da1f0b11bd359b1574fbf86c1c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#af8c29da1f0b11bd359b1574fbf86c1c8">More...</a><br /></td></tr>
158 <tr class="separator:af8c29da1f0b11bd359b1574fbf86c1c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:a1aea9496b59f665829dfebcac7c6e8f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a1aea9496b59f665829dfebcac7c6e8f3">configure</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input_x, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input_y, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output_x, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output_y, bool border_undefined)</td></tr>
160 <tr class="memdesc:a1aea9496b59f665829dfebcac7c6e8f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's source, destination and border mode.  <a href="#a1aea9496b59f665829dfebcac7c6e8f3">More...</a><br /></td></tr>
161 <tr class="separator:a1aea9496b59f665829dfebcac7c6e8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
163 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br /></td></tr>
164 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
166 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
167 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
169 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
170 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
171 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
173 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
174 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
175 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
177 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
178 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
180 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
181 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
183 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
184 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 </table>
186 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
187 <div class="textblock"><p>Interface for the kernel to run the vertical pass of 5x5 Sobel Y filter on a tensor. </p>
188
189 <p>Definition at line <a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml#l00083">83</a> of file <a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml">NESobel5x5Kernel.h</a>.</p>
190 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
191 <a class="anchor" id="ab46cf54e2df5a20b634660a06e48e9d5"></a>
192 <div class="memitem">
193 <div class="memproto">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> </td>
197           <td>(</td>
198           <td class="paramname"></td><td>)</td>
199           <td></td>
200         </tr>
201       </table>
202 </div><div class="memdoc">
203
204 <p>Default constructor. </p>
205
206 </div>
207 </div>
208 <a class="anchor" id="aefe5ee52a24df017a67c5fe79ac0d19f"></a>
209 <div class="memitem">
210 <div class="memproto">
211 <table class="mlabels">
212   <tr>
213   <td class="mlabels-left">
214       <table class="memname">
215         <tr>
216           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> </td>
217           <td>(</td>
218           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&#160;</td>
219           <td class="paramname"></td><td>)</td>
220           <td></td>
221         </tr>
222       </table>
223   </td>
224   <td class="mlabels-right">
225 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
226   </tr>
227 </table>
228 </div><div class="memdoc">
229
230 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
231
232 </div>
233 </div>
234 <a class="anchor" id="a2ff0db37338bc4f3cbc18e51ce0317ae"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238   <tr>
239   <td class="mlabels-left">
240       <table class="memname">
241         <tr>
242           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> </td>
243           <td>(</td>
244           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&amp;&#160;</td>
245           <td class="paramname"></td><td>)</td>
246           <td></td>
247         </tr>
248       </table>
249   </td>
250   <td class="mlabels-right">
251 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
252   </tr>
253 </table>
254 </div><div class="memdoc">
255
256 <p>Allow instances of this class to be moved. </p>
257
258 </div>
259 </div>
260 <a class="anchor" id="af8c29da1f0b11bd359b1574fbf86c1c8"></a>
261 <div class="memitem">
262 <div class="memproto">
263 <table class="mlabels">
264   <tr>
265   <td class="mlabels-left">
266       <table class="memname">
267         <tr>
268           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> </td>
269           <td>(</td>
270           <td class="paramname"></td><td>)</td>
271           <td></td>
272         </tr>
273       </table>
274   </td>
275   <td class="mlabels-right">
276 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
277   </tr>
278 </table>
279 </div><div class="memdoc">
280
281 <p>Default destructor. </p>
282
283 </div>
284 </div>
285 <h2 class="groupheader">Member Function Documentation</h2>
286 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
287 <div class="memitem">
288 <div class="memproto">
289 <table class="mlabels">
290   <tr>
291   <td class="mlabels-left">
292       <table class="memname">
293         <tr>
294           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
295           <td>(</td>
296           <td class="paramname"></td><td>)</td>
297           <td> const</td>
298         </tr>
299       </table>
300   </td>
301   <td class="mlabels-right">
302 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
303   </tr>
304 </table>
305 </div><div class="memdoc">
306
307 <p>The size of the border for that kernel. </p>
308 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
309
310 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
311
312 </div>
313 </div>
314 <a class="anchor" id="a1aea9496b59f665829dfebcac7c6e8f3"></a>
315 <div class="memitem">
316 <div class="memproto">
317       <table class="memname">
318         <tr>
319           <td class="memname">void configure </td>
320           <td>(</td>
321           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
322           <td class="paramname"><em>input_x</em>, </td>
323         </tr>
324         <tr>
325           <td class="paramkey"></td>
326           <td></td>
327           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
328           <td class="paramname"><em>input_y</em>, </td>
329         </tr>
330         <tr>
331           <td class="paramkey"></td>
332           <td></td>
333           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
334           <td class="paramname"><em>output_x</em>, </td>
335         </tr>
336         <tr>
337           <td class="paramkey"></td>
338           <td></td>
339           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
340           <td class="paramname"><em>output_y</em>, </td>
341         </tr>
342         <tr>
343           <td class="paramkey"></td>
344           <td></td>
345           <td class="paramtype">bool&#160;</td>
346           <td class="paramname"><em>border_undefined</em>&#160;</td>
347         </tr>
348         <tr>
349           <td></td>
350           <td>)</td>
351           <td></td><td></td>
352         </tr>
353       </table>
354 </div><div class="memdoc">
355
356 <p>Initialise the kernel's source, destination and border mode. </p>
357 <dl class="params"><dt>Parameters</dt><dd>
358   <table class="params">
359     <tr><td class="paramdir">[in]</td><td class="paramname">input_x</td><td>Input for X (X output of hor pass). Data type supported: S16. </td></tr>
360     <tr><td class="paramdir">[in]</td><td class="paramname">input_y</td><td>Input for Y (Y output of hor pass). Data type supported: S16. </td></tr>
361     <tr><td class="paramdir">[out]</td><td class="paramname">output_x</td><td>Destination tensor for the X gradient. Data type supported: S16. </td></tr>
362     <tr><td class="paramdir">[out]</td><td class="paramname">output_y</td><td>Destination tensor for the Y gradient. Data type supported: S16. </td></tr>
363     <tr><td class="paramdir">[in]</td><td class="paramname">border_undefined</td><td>True if the border mode is undefined. False if it's replicate or constant. </td></tr>
364   </table>
365   </dd>
366 </dl>
367
368 </div>
369 </div>
370 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
371 <div class="memitem">
372 <div class="memproto">
373 <table class="mlabels">
374   <tr>
375   <td class="mlabels-left">
376       <table class="memname">
377         <tr>
378           <td class="memname">const char* name </td>
379           <td>(</td>
380           <td class="paramname"></td><td>)</td>
381           <td> const</td>
382         </tr>
383       </table>
384   </td>
385   <td class="mlabels-right">
386 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
387   </tr>
388 </table>
389 </div><div class="memdoc">
390
391 <p>Name of the kernel. </p>
392 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
393
394 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
395
396 <p>Definition at line <a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml#l00086">86</a> of file <a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml">NESobel5x5Kernel.h</a>.</p>
397
398 <p>References <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_hor_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">NESobel5x5HorKernel::border_size()</a>, <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_hor_kernel.xhtml#ace7523f9c3073ad82b77e46318a1ea77">NESobel5x5HorKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_hor_kernel.xhtml#a9e6242e9d05e2d354358200b6b0c9bce">NESobel5x5HorKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_hor_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NESobel5x5HorKernel::run()</a>, and <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>.</p>
399 <div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NESobel5x5VertKernel&quot;</span>;</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    }</div></div><!-- fragment -->
400 </div>
401 </div>
402 <a class="anchor" id="a8954c998e67758f56891caf8da30c953"></a>
403 <div class="memitem">
404 <div class="memproto">
405 <table class="mlabels">
406   <tr>
407   <td class="mlabels-left">
408       <table class="memname">
409         <tr>
410           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a>&amp; operator= </td>
411           <td>(</td>
412           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&#160;</td>
413           <td class="paramname"></td><td>)</td>
414           <td></td>
415         </tr>
416       </table>
417   </td>
418   <td class="mlabels-right">
419 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
420   </tr>
421 </table>
422 </div><div class="memdoc">
423
424 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
425
426 </div>
427 </div>
428 <a class="anchor" id="a59d1a2b1ef3d2b7e3bc5e942714d102a"></a>
429 <div class="memitem">
430 <div class="memproto">
431 <table class="mlabels">
432   <tr>
433   <td class="mlabels-left">
434       <table class="memname">
435         <tr>
436           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a>&amp; operator= </td>
437           <td>(</td>
438           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a> &amp;&amp;&#160;</td>
439           <td class="paramname"></td><td>)</td>
440           <td></td>
441         </tr>
442       </table>
443   </td>
444   <td class="mlabels-right">
445 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
446   </tr>
447 </table>
448 </div><div class="memdoc">
449
450 <p>Allow instances of this class to be moved. </p>
451
452 </div>
453 </div>
454 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
455 <div class="memitem">
456 <div class="memproto">
457 <table class="mlabels">
458   <tr>
459   <td class="mlabels-left">
460       <table class="memname">
461         <tr>
462           <td class="memname">void run </td>
463           <td>(</td>
464           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
465           <td class="paramname"><em>window</em>, </td>
466         </tr>
467         <tr>
468           <td class="paramkey"></td>
469           <td></td>
470           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
471           <td class="paramname"><em>info</em>&#160;</td>
472         </tr>
473         <tr>
474           <td></td>
475           <td>)</td>
476           <td></td><td></td>
477         </tr>
478       </table>
479   </td>
480   <td class="mlabels-right">
481 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
482   </tr>
483 </table>
484 </div><div class="memdoc">
485
486 <p>Execute the kernel on the passed window. </p>
487 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
488 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
489 <dd>
490 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
491 <dl class="params"><dt>Parameters</dt><dd>
492   <table class="params">
493     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
494     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
495   </table>
496   </dd>
497 </dl>
498
499 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
500
501 </div>
502 </div>
503 <hr/>The documentation for this class was generated from the following file:<ul>
504 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_sobel5x5_kernel_8h_source.xhtml">NESobel5x5Kernel.h</a></li>
505 </ul>
506 </div><!-- contents -->
507 </div><!-- doc-content -->
508 <!-- start footer part -->
509 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
510   <ul>
511     <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_n_e_sobel5x5_vert_kernel.xhtml">NESobel5x5VertKernel</a></li>
512     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
513     <a href="http://www.doxygen.org/index.html">
514     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
515   </ul>
516 </div>
517 </body>
518 </html>