documentation/classarm__compute_1_1_n_e_magnitude_phase_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: NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt; 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);
  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_magnitude_phase_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">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt; Class Template Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 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>
 127
 128 <p><code>#include &lt;<a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml">NEMagnitudePhaseKernel.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;:</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>
 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_magnitude_phase_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:a53c147feec3c6f2912779194fa2b5513"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a53c147feec3c6f2912779194fa2b5513">More...</a><br /></td></tr>
 143 <tr class="separator:a53c147feec3c6f2912779194fa2b5513"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a1bd4859d9eadb11c47c40235e2b4d044"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">Destructor.  <a href="#a1bd4859d9eadb11c47c40235e2b4d044">More...</a><br /></td></tr>
 146 <tr class="separator:a1bd4859d9eadb11c47c40235e2b4d044"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:aebf700d44017c1ff38ad0d3741aaac56"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;)=delete</td></tr>
 148 <tr class="memdesc:aebf700d44017c1ff38ad0d3741aaac56"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
 150 <tr class="memitem:ac0a5198310dfa51fb02e28e2594e1d53"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;&amp;)=default</td></tr>
 151 <tr class="memdesc:ac0a5198310dfa51fb02e28e2594e1d53"><td class="mdescLeft">&#160;</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">&#160;</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> &amp;&#160;</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> &amp;)=delete</td></tr>
 154 <tr class="memdesc:a792f1b5315b3678896a2dd5eab8b692b"><td class="mdescLeft">&#160;</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">&#160;</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> &amp;&#160;</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> &amp;&amp;)=default</td></tr>
 157 <tr class="memdesc:ad45c0851db2721a94c831cbc6f30a037"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
 159 <tr class="memitem:a885b754efced9144226ada4c202574b6"><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_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">&#160;</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">&#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_magnitude_phase_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="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>
 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&#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>
 167 <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>
 168 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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">&#160;</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">&#160;</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">&#160;</td></tr>
 173 <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>
 174 <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>
 175 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</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&#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>
 177 <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>
 178 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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">&#160;</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">&#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"><h3>template&lt;MagnitudeType mag_type, PhaseType phase_type&gt;<br />
 188 class arm_compute::NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;</h3>
 189
 190 <p>Template interface for the kernel to compute magnitude and phase. </p>
 191
 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 &amp; Destructor Documentation</h2>
 194 <a class="anchor" id="a53c147feec3c6f2912779194fa2b5513"></a>
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
 200           <td>(</td>
 201           <td class="paramname"></td><td>)</td>
 202           <td></td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206
 207 <p>Default constructor. </p>
 208
 209 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::name()</a>.</p>
 210
 211 </div>
 212 </div>
 213 <a class="anchor" id="a1bd4859d9eadb11c47c40235e2b4d044"></a>
 214 <div class="memitem">
 215 <div class="memproto">
 216 <table class="mlabels">
 217   <tr>
 218   <td class="mlabels-left">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
 222           <td>(</td>
 223           <td class="paramname"></td><td>)</td>
 224           <td></td>
 225         </tr>
 226       </table>
 227   </td>
 228   <td class="mlabels-right">
 229 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 230   </tr>
 231 </table>
 232 </div><div class="memdoc">
 233
 234 <p>Destructor. </p>
 235
 236 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::name()</a>.</p>
 237
 238 </div>
 239 </div>
 240 <a class="anchor" id="aebf700d44017c1ff38ad0d3741aaac56"></a>
 241 <div class="memitem">
 242 <div class="memproto">
 243 <table class="mlabels">
 244   <tr>
 245   <td class="mlabels-left">
 246       <table class="memname">
 247         <tr>
 248           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
 249           <td>(</td>
 250           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&lt; mag_type, phase_type &gt; &amp;&#160;</td>
 251           <td class="paramname"></td><td>)</td>
 252           <td></td>
 253         </tr>
 254       </table>
 255   </td>
 256   <td class="mlabels-right">
 257 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 258   </tr>
 259 </table>
 260 </div><div class="memdoc">
 261
 262 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 263
 264 </div>
 265 </div>
 266 <a class="anchor" id="ac0a5198310dfa51fb02e28e2594e1d53"></a>
 267 <div class="memitem">
 268 <div class="memproto">
 269 <table class="mlabels">
 270   <tr>
 271   <td class="mlabels-left">
 272       <table class="memname">
 273         <tr>
 274           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a> </td>
 275           <td>(</td>
 276           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&lt; mag_type, phase_type &gt; &amp;&amp;&#160;</td>
 277           <td class="paramname"></td><td>)</td>
 278           <td></td>
 279         </tr>
 280       </table>
 281   </td>
 282   <td class="mlabels-right">
 283 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 284   </tr>
 285 </table>
 286 </div><div class="memdoc">
 287
 288 <p>Default move constructor. </p>
 289
 290 </div>
 291 </div>
 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">
 297         <tr>
 298           <td class="memname">void configure </td>
 299           <td>(</td>
 300           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 301           <td class="paramname"><em>gx</em>, </td>
 302         </tr>
 303         <tr>
 304           <td class="paramkey"></td>
 305           <td></td>
 306           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 307           <td class="paramname"><em>gy</em>, </td>
 308         </tr>
 309         <tr>
 310           <td class="paramkey"></td>
 311           <td></td>
 312           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 313           <td class="paramname"><em>magnitude</em>, </td>
 314         </tr>
 315         <tr>
 316           <td class="paramkey"></td>
 317           <td></td>
 318           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 319           <td class="paramname"><em>phase</em>&#160;</td>
 320         </tr>
 321         <tr>
 322           <td></td>
 323           <td>)</td>
 324           <td></td><td></td>
 325         </tr>
 326       </table>
 327 </div><div class="memdoc">
 328
 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>
 337   </table>
 338   </dd>
 339 </dl>
 340
 341 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::name()</a>.</p>
 342
 343 </div>
 344 </div>
 345 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
 346 <div class="memitem">
 347 <div class="memproto">
 348 <table class="mlabels">
 349   <tr>
 350   <td class="mlabels-left">
 351       <table class="memname">
 352         <tr>
 353           <td class="memname">const char* name </td>
 354           <td>(</td>
 355           <td class="paramname"></td><td>)</td>
 356           <td> const</td>
 357         </tr>
 358       </table>
 359   </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>
 362   </tr>
 363 </table>
 364 </div><div class="memdoc">
 365
 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>
 368
 369 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
 370
 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>
 372
 373 <p>References <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a885b754efced9144226ada4c202574b6">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::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&lt; mag_type, phase_type &gt;::NEMagnitudePhaseKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a792f1b5315b3678896a2dd5eab8b692b">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::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&lt; mag_type, phase_type &gt;::~NEMagnitudePhaseKernel()</a>.</p>
 374 <div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    {</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEMagnitudePhaseKernel&quot;</span>;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    }</div></div><!-- fragment -->
 375 </div>
 376 </div>
 377 <a class="anchor" id="a792f1b5315b3678896a2dd5eab8b692b"></a>
 378 <div class="memitem">
 379 <div class="memproto">
 380 <table class="mlabels">
 381   <tr>
 382   <td class="mlabels-left">
 383       <table class="memname">
 384         <tr>
 385           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&amp; operator= </td>
 386           <td>(</td>
 387           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&lt; mag_type, phase_type &gt; &amp;&#160;</td>
 388           <td class="paramname"></td><td>)</td>
 389           <td></td>
 390         </tr>
 391       </table>
 392   </td>
 393   <td class="mlabels-right">
 394 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 395   </tr>
 396 </table>
 397 </div><div class="memdoc">
 398
 399 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 400
 401 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::name()</a>.</p>
 402
 403 </div>
 404 </div>
 405 <a class="anchor" id="ad45c0851db2721a94c831cbc6f30a037"></a>
 406 <div class="memitem">
 407 <div class="memproto">
 408 <table class="mlabels">
 409   <tr>
 410   <td class="mlabels-left">
 411       <table class="memname">
 412         <tr>
 413           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&amp; operator= </td>
 414           <td>(</td>
 415           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_magnitude_phase_kernel.xhtml">NEMagnitudePhaseKernel</a>&lt; mag_type, phase_type &gt; &amp;&amp;&#160;</td>
 416           <td class="paramname"></td><td>)</td>
 417           <td></td>
 418         </tr>
 419       </table>
 420   </td>
 421   <td class="mlabels-right">
 422 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 423   </tr>
 424 </table>
 425 </div><div class="memdoc">
 426
 427 <p>Default move assignment operator. </p>
 428
 429 </div>
 430 </div>
 431 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
 432 <div class="memitem">
 433 <div class="memproto">
 434 <table class="mlabels">
 435   <tr>
 436   <td class="mlabels-left">
 437       <table class="memname">
 438         <tr>
 439           <td class="memname">void run </td>
 440           <td>(</td>
 441           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 442           <td class="paramname"><em>window</em>, </td>
 443         </tr>
 444         <tr>
 445           <td class="paramkey"></td>
 446           <td></td>
 447           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
 448           <td class="paramname"><em>info</em>&#160;</td>
 449         </tr>
 450         <tr>
 451           <td></td>
 452           <td>)</td>
 453           <td></td><td></td>
 454         </tr>
 455       </table>
 456   </td>
 457   <td class="mlabels-right">
 458 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 459   </tr>
 460 </table>
 461 </div><div class="memdoc">
 462
 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>
 466 <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>
 472   </table>
 473   </dd>
 474 </dl>
 475
 476 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
 477
 478 <p>Referenced by <a class="el" href="_n_e_magnitude_phase_kernel_8h_source.xhtml#l00039">NEMagnitudePhaseKernel&lt; mag_type, phase_type &gt;::name()</a>.</p>
 479
 480 </div>
 481 </div>
 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>
 484 </ul>
 485 </div><!-- contents -->
 486 </div><!-- doc-content -->
 487 <!-- start footer part -->
 488 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 489   <ul>
 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 Wed May 23 2018 11:36:42 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>
 494   </ul>
 495 </div>
 496 </body>
 497 </html>