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>Compute Library: NEMagnitudePhaseKernel< mag_type, phase_type > Class Template 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">Compute Library
43  <span id="projectnumber">18.02</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="pages.xhtml"><span>Related 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 Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
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>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml','');});
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)">
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">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">NEMagnitudePhaseKernel< mag_type, phase_type > Class Template Reference</div> </div>
123 <div class="contents">
125 <p>Template interface for the kernel to compute magnitude and phase.
126 <a href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml">NEMagnitudePhaseKernel.h</a>></code></p>
129 <div class="dynheader">
130 Collaboration diagram for NEMagnitudePhaseKernel< mag_type, phase_type >:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_magnitude_phase_kernel__coll__graph.svg" width="210" height="202"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
139 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft"> </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"> </td></tr>
141 <tr class="memitem:a53c147feec3c6f2912779194fa2b5513"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a53c147feec3c6f2912779194fa2b5513">NEMagnitudePhaseKernel</a> ()</td></tr>
142 <tr class="memdesc:a53c147feec3c6f2912779194fa2b5513"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a53c147feec3c6f2912779194fa2b5513">More...</a><br /></td></tr>
143 <tr class="separator:a53c147feec3c6f2912779194fa2b5513"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:a1bd4859d9eadb11c47c40235e2b4d044"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a1bd4859d9eadb11c47c40235e2b4d044">~NEMagnitudePhaseKernel</a> ()=default</td></tr>
145 <tr class="memdesc:a1bd4859d9eadb11c47c40235e2b4d044"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a1bd4859d9eadb11c47c40235e2b4d044">More...</a><br /></td></tr>
146 <tr class="separator:a1bd4859d9eadb11c47c40235e2b4d044"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:aebf700d44017c1ff38ad0d3741aaac56"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#aebf700d44017c1ff38ad0d3741aaac56">NEMagnitudePhaseKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> &)=delete</td></tr>
148 <tr class="memdesc:aebf700d44017c1ff38ad0d3741aaac56"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#aebf700d44017c1ff38ad0d3741aaac56">More...</a><br /></td></tr>
149 <tr class="separator:aebf700d44017c1ff38ad0d3741aaac56"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:ac0a5198310dfa51fb02e28e2594e1d53"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#ac0a5198310dfa51fb02e28e2594e1d53">NEMagnitudePhaseKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> &&)=default</td></tr>
151 <tr class="memdesc:ac0a5198310dfa51fb02e28e2594e1d53"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <a href="#ac0a5198310dfa51fb02e28e2594e1d53">More...</a><br /></td></tr>
152 <tr class="separator:ac0a5198310dfa51fb02e28e2594e1d53"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:a792f1b5315b3678896a2dd5eab8b692b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a792f1b5315b3678896a2dd5eab8b692b">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> &)=delete</td></tr>
154 <tr class="memdesc:a792f1b5315b3678896a2dd5eab8b692b"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#a792f1b5315b3678896a2dd5eab8b692b">More...</a><br /></td></tr>
155 <tr class="separator:a792f1b5315b3678896a2dd5eab8b692b"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:ad45c0851db2721a94c831cbc6f30a037"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#ad45c0851db2721a94c831cbc6f30a037">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> &&)=default</td></tr>
157 <tr class="memdesc:ad45c0851db2721a94c831cbc6f30a037"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <a href="#ad45c0851db2721a94c831cbc6f30a037">More...</a><br /></td></tr>
158 <tr class="separator:ad45c0851db2721a94c831cbc6f30a037"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:a885b754efced9144226ada4c202574b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a885b754efced9144226ada4c202574b6">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *gx, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *gy, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *magnitude, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *phase)</td></tr>
160 <tr class="memdesc:a885b754efced9144226ada4c202574b6"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the kernel's input, output. <a href="#a885b754efced9144226ada4c202574b6">More...</a><br /></td></tr>
161 <tr class="separator:a885b754efced9144226ada4c202574b6"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &<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> &info) override</td></tr>
163 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft"> </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"> </td></tr>
165 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
166 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual </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>
167 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
168 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2"> </td></tr>
169 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
170 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
171 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
172 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
173 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
174 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
175 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
176 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
177 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether or not the kernel is parallelisable. <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
178 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
179 <tr class="memitem:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
180 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">The size of the border for that kernel. <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
181 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </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> & </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"> </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"> </td></tr>
186 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
187 <div class="textblock"><h3>template<MagnitudeType mag_type, PhaseType phase_type><br />
188 class arm_compute::NEMagnitudePhaseKernel< mag_type, phase_type ></h3>
190 <p>Template interface for the kernel to compute magnitude and phase. </p>
192 <p>Definition at line <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml">NEMagnitudePhaseKernel.h</a>.</p>
193 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
194 <a class="anchor" id="a53c147feec3c6f2912779194fa2b5513"></a>
195 <div class="memitem">
196 <div class="memproto">
197 <table class="memname">
199 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
201 <td class="paramname"></td><td>)</td>
205 </div><div class="memdoc">
207 <p>Default constructor. </p>
209 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel< mag_type, phase_type >::name()</a>.</p>
213 <a class="anchor" id="a1bd4859d9eadb11c47c40235e2b4d044"></a>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="mlabels">
218 <td class="mlabels-left">
219 <table class="memname">
221 <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
223 <td class="paramname"></td><td>)</td>
228 <td class="mlabels-right">
229 <span class="mlabels"><span class="mlabel">default</span></span> </td>
232 </div><div class="memdoc">
236 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel< mag_type, phase_type >::name()</a>.</p>
240 <a class="anchor" id="aebf700d44017c1ff38ad0d3741aaac56"></a>
241 <div class="memitem">
242 <div class="memproto">
243 <table class="mlabels">
245 <td class="mlabels-left">
246 <table class="memname">
248 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
250 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>< mag_type, phase_type > & </td>
251 <td class="paramname"></td><td>)</td>
256 <td class="mlabels-right">
257 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
260 </div><div class="memdoc">
262 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
266 <a class="anchor" id="ac0a5198310dfa51fb02e28e2594e1d53"></a>
267 <div class="memitem">
268 <div class="memproto">
269 <table class="mlabels">
271 <td class="mlabels-left">
272 <table class="memname">
274 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
276 <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>< mag_type, phase_type > && </td>
277 <td class="paramname"></td><td>)</td>
282 <td class="mlabels-right">
283 <span class="mlabels"><span class="mlabel">default</span></span> </td>
286 </div><div class="memdoc">
288 <p>Default move constructor. </p>
292 <h2 class="groupheader">Member Function Documentation</h2>
293 <a class="anchor" id="a885b754efced9144226ada4c202574b6"></a>
294 <div class="memitem">
295 <div class="memproto">
296 <table class="memname">
298 <td class="memname">void configure </td>
300 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
301 <td class="paramname"><em>gx</em>, </td>
304 <td class="paramkey"></td>
306 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
307 <td class="paramname"><em>gy</em>, </td>
310 <td class="paramkey"></td>
312 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
313 <td class="paramname"><em>magnitude</em>, </td>
316 <td class="paramkey"></td>
318 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
319 <td class="paramname"><em>phase</em> </td>
327 </div><div class="memdoc">
329 <p>Initialise the kernel's input, output. </p>
330 <dl class="section note"><dt>Note</dt><dd>At least one of out1 or out2 must be set</dd></dl>
331 <dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramdir">[in]</td><td class="paramname">gx</td><td>Gradient X tensor. Data type supported: S16. </td></tr>
334 <tr><td class="paramdir">[in]</td><td class="paramname">gy</td><td>Gradient Y tensor. Data type supported: S16. </td></tr>
335 <tr><td class="paramdir">[out]</td><td class="paramname">magnitude</td><td>(Optional) The output tensor - Magnitude. Data type supported: S16. </td></tr>
336 <tr><td class="paramdir">[out]</td><td class="paramname">phase</td><td>(Optional) The output tensor - Phase. Data type supported: U8. </td></tr>
341 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel< mag_type, phase_type >::name()</a>.</p>
345 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
346 <div class="memitem">
347 <div class="memproto">
348 <table class="mlabels">
350 <td class="mlabels-left">
351 <table class="memname">
353 <td class="memname">const char* name </td>
355 <td class="paramname"></td><td>)</td>
360 <td class="mlabels-right">
361 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
364 </div><div class="memdoc">
366 <p>Name of the kernel. </p>
367 <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>
369 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
371 <p>Definition at line <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml">NEMagnitudePhaseKernel.h</a>.</p>
373 <p>References <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a885b754efced9144226ada4c202574b6">NEMagnitudePhaseKernel< mag_type, phase_type >::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="magnitude__phase_8cl_source.xhtml#l00130">magnitude_phase()</a>, <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a53c147feec3c6f2912779194fa2b5513">NEMagnitudePhaseKernel< mag_type, phase_type >::NEMagnitudePhaseKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a792f1b5315b3678896a2dd5eab8b692b">NEMagnitudePhaseKernel< mag_type, phase_type >::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEMagnitudePhaseKernel< mag_type, phase_type >::run()</a>, <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>, and <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a1bd4859d9eadb11c47c40235e2b4d044">NEMagnitudePhaseKernel< mag_type, phase_type >::~NEMagnitudePhaseKernel()</a>.</p>
374 <div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> <span class="stringliteral">"NEMagnitudePhaseKernel"</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div></div><!-- fragment -->
377 <a class="anchor" id="a792f1b5315b3678896a2dd5eab8b692b"></a>
378 <div class="memitem">
379 <div class="memproto">
380 <table class="mlabels">
382 <td class="mlabels-left">
383 <table class="memname">
385 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>& operator= </td>
387 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>< mag_type, phase_type > & </td>
388 <td class="paramname"></td><td>)</td>
393 <td class="mlabels-right">
394 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
397 </div><div class="memdoc">
399 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
401 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel< mag_type, phase_type >::name()</a>.</p>
405 <a class="anchor" id="ad45c0851db2721a94c831cbc6f30a037"></a>
406 <div class="memitem">
407 <div class="memproto">
408 <table class="mlabels">
410 <td class="mlabels-left">
411 <table class="memname">
413 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>& operator= </td>
415 <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>< mag_type, phase_type > && </td>
416 <td class="paramname"></td><td>)</td>
421 <td class="mlabels-right">
422 <span class="mlabels"><span class="mlabel">default</span></span> </td>
425 </div><div class="memdoc">
427 <p>Default move assignment operator. </p>
431 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
432 <div class="memitem">
433 <div class="memproto">
434 <table class="mlabels">
436 <td class="mlabels-left">
437 <table class="memname">
439 <td class="memname">void run </td>
441 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
442 <td class="paramname"><em>window</em>, </td>
445 <td class="paramkey"></td>
447 <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> & </td>
448 <td class="paramname"><em>info</em> </td>
457 <td class="mlabels-right">
458 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
461 </div><div class="memdoc">
463 <p>Execute the kernel on the passed window. </p>
464 <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>
465 <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>
467 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
468 <dl class="params"><dt>Parameters</dt><dd>
469 <table class="params">
470 <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>
471 <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
476 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
478 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel< mag_type, phase_type >::name()</a>.</p>
482 <hr/>The documentation for this class was generated from the following file:<ul>
483 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml">NEMagnitudePhaseKernel.h</a></li>
485 </div><!-- contents -->
486 </div><!-- doc-content -->
487 <!-- start footer part -->
488 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
490 <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_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a></li>
491 <li class="footer">Generated on Thu Feb 22 2018 15:45:25 for Compute Library by
492 <a href="http://www.doxygen.org/index.html">
493 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>