documentation/classarm__compute_1_1_c_l_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>ARM Compute Library: CLMagnitudePhaseKernel 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">CLMagnitudePhaseKernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Template interface for the kernel to compute magnitude and phase.
 125  <a href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_magnitude_phase_kernel_8h_source.xhtml">CLMagnitudePhaseKernel.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLMagnitudePhaseKernel:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_magnitude_phase_kernel__coll__graph.svg" width="184" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:a249ee7b7204a6f63cf3563eda92e4d0e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a249ee7b7204a6f63cf3563eda92e4d0e">CLMagnitudePhaseKernel</a> ()</td></tr>
 138 <tr class="memdesc:a249ee7b7204a6f63cf3563eda92e4d0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a249ee7b7204a6f63cf3563eda92e4d0e">More...</a><br /></td></tr>
 139 <tr class="separator:a249ee7b7204a6f63cf3563eda92e4d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a26b6db53a3b87bcf6476d95d45dff938"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a26b6db53a3b87bcf6476d95d45dff938">CLMagnitudePhaseKernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:a26b6db53a3b87bcf6476d95d45dff938"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a26b6db53a3b87bcf6476d95d45dff938">More...</a><br /></td></tr>
 142 <tr class="separator:a26b6db53a3b87bcf6476d95d45dff938"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a11f21edc185eb160e844aa0c4ca9c29a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a11f21edc185eb160e844aa0c4ca9c29a">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;)=delete</td></tr>
 144 <tr class="memdesc:a11f21edc185eb160e844aa0c4ca9c29a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a11f21edc185eb160e844aa0c4ca9c29a">More...</a><br /></td></tr>
 145 <tr class="separator:a11f21edc185eb160e844aa0c4ca9c29a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:acb7d0c0476a914425a66e6f2c0c478b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#acb7d0c0476a914425a66e6f2c0c478b4">CLMagnitudePhaseKernel</a> (<a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:acb7d0c0476a914425a66e6f2c0c478b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#acb7d0c0476a914425a66e6f2c0c478b4">More...</a><br /></td></tr>
 148 <tr class="separator:acb7d0c0476a914425a66e6f2c0c478b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:adb678b97316f473c8134729d88d22513"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#adb678b97316f473c8134729d88d22513">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&amp;)=default</td></tr>
 150 <tr class="memdesc:adb678b97316f473c8134729d88d22513"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#adb678b97316f473c8134729d88d22513">More...</a><br /></td></tr>
 151 <tr class="separator:adb678b97316f473c8134729d88d22513"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a97c0a4edbeca3c32dda036b81446a4d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a97c0a4edbeca3c32dda036b81446a4d9">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *gx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *gy, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *magnitude, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *phase, <a class="el" href="namespacearm__compute.xhtml#a7b3ec6413f000b02fdb4e39a951d9f8a">MagnitudeType</a> mag_type=<a class="el" href="namespacearm__compute.xhtml#a7b3ec6413f000b02fdb4e39a951d9f8aad927ac799e8b24f80fc80d89b2eb7131">MagnitudeType::L2NORM</a>, <a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72">PhaseType</a> phase_type=<a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72a6898b46a1cde8a1572e2722c44c5ab07">PhaseType::SIGNED</a>)</td></tr>
 153 <tr class="memdesc:a97c0a4edbeca3c32dda036b81446a4d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input, output.  <a href="#a97c0a4edbeca3c32dda036b81446a4d9">More...</a><br /></td></tr>
 154 <tr class="separator:a97c0a4edbeca3c32dda036b81446a4d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a493987e85723a8000eb26d1f00e2ad0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">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>, cl::CommandQueue &amp;queue) override</td></tr>
 156 <tr class="memdesc:a493987e85723a8000eb26d1f00e2ad0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.  <a href="#a493987e85723a8000eb26d1f00e2ad0e">More...</a><br /></td></tr>
 157 <tr class="separator:a493987e85723a8000eb26d1f00e2ad0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a></td></tr>
 159 <tr class="memitem:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a6b10e96ce90bf901d17def86b874b019">ICLKernel</a> ()</td></tr>
 160 <tr class="memdesc:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6b10e96ce90bf901d17def86b874b019">More...</a><br /></td></tr>
 161 <tr class="separator:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">cl::Kernel &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ae5121015ab09ece4d470f50c7ffe198e">kernel</a> ()</td></tr>
 163 <tr class="memdesc:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the OpenCL kernel of this object.  <a href="#ae5121015ab09ece4d470f50c7ffe198e">More...</a><br /></td></tr>
 164 <tr class="separator:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a479e7043e65dc87de35d374e108510f7">add_1D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 166 <tr class="memdesc:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a479e7043e65dc87de35d374e108510f7">More...</a><br /></td></tr>
 167 <tr class="separator:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac74dad3e61f79334f5e73f3c3ac603cb">add_2D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 169 <tr class="memdesc:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#ac74dad3e61f79334f5e73f3c3ac603cb">More...</a><br /></td></tr>
 170 <tr class="separator:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a28f5847162f352444c6ac1825d0e99c7">add_3D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 172 <tr class="memdesc:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a28f5847162f352444c6ac1825d0e99c7">More...</a><br /></td></tr>
 173 <tr class="separator:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a770f45838881fc061294e56d64f34386">num_arguments_per_1D_tensor</a> () const </td></tr>
 175 <tr class="memdesc:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 1D tensor object.  <a href="#a770f45838881fc061294e56d64f34386">More...</a><br /></td></tr>
 176 <tr class="separator:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac734502531e7f95e25b3bf688a304a59">num_arguments_per_2D_tensor</a> () const </td></tr>
 178 <tr class="memdesc:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 2D tensor object.  <a href="#ac734502531e7f95e25b3bf688a304a59">More...</a><br /></td></tr>
 179 <tr class="separator:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a4feaae9c860cddfa843d37c953674a22">num_arguments_per_3D_tensor</a> () const </td></tr>
 181 <tr class="memdesc:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 3D tensor object.  <a href="#a4feaae9c860cddfa843d37c953674a22">More...</a><br /></td></tr>
 182 <tr class="separator:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
 184 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a50f427a1d9419800972b9e03c4034311">add_argument</a> (unsigned int &amp;idx, T value)</td></tr>
 185 <tr class="memdesc:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed parameters to the object's kernel's arguments starting from the index idx.  <a href="#a50f427a1d9419800972b9e03c4034311">More...</a><br /></td></tr>
 186 <tr class="separator:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 <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>
 188 <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>
 189 <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>
 190 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <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>
 192 <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>
 193 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 <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>
 195 <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>
 196 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 <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>
 198 <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>
 199 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 <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>
 201 <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>
 202 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 </table>
 204 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 205 <div class="textblock"><p>Template interface for the kernel to compute magnitude and phase. </p>
 206
 207 <p>Definition at line <a class="el" href="_c_l_magnitude_phase_kernel_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_l_magnitude_phase_kernel_8h_source.xhtml">CLMagnitudePhaseKernel.h</a>.</p>
 208 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 209 <a class="anchor" id="a249ee7b7204a6f63cf3563eda92e4d0e"></a>
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> </td>
 215           <td>(</td>
 216           <td class="paramname"></td><td>)</td>
 217           <td></td>
 218         </tr>
 219       </table>
 220 </div><div class="memdoc">
 221
 222 <p>Default constructor. </p>
 223
 224 </div>
 225 </div>
 226 <a class="anchor" id="a26b6db53a3b87bcf6476d95d45dff938"></a>
 227 <div class="memitem">
 228 <div class="memproto">
 229 <table class="mlabels">
 230   <tr>
 231   <td class="mlabels-left">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> </td>
 235           <td>(</td>
 236           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&#160;</td>
 237           <td class="paramname"></td><td>)</td>
 238           <td></td>
 239         </tr>
 240       </table>
 241   </td>
 242   <td class="mlabels-right">
 243 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 244   </tr>
 245 </table>
 246 </div><div class="memdoc">
 247
 248 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
 249
 250 </div>
 251 </div>
 252 <a class="anchor" id="acb7d0c0476a914425a66e6f2c0c478b4"></a>
 253 <div class="memitem">
 254 <div class="memproto">
 255 <table class="mlabels">
 256   <tr>
 257   <td class="mlabels-left">
 258       <table class="memname">
 259         <tr>
 260           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> </td>
 261           <td>(</td>
 262           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&amp;&#160;</td>
 263           <td class="paramname"></td><td>)</td>
 264           <td></td>
 265         </tr>
 266       </table>
 267   </td>
 268   <td class="mlabels-right">
 269 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 270   </tr>
 271 </table>
 272 </div><div class="memdoc">
 273
 274 <p>Allow instances of this class to be moved. </p>
 275
 276 </div>
 277 </div>
 278 <h2 class="groupheader">Member Function Documentation</h2>
 279 <a class="anchor" id="a97c0a4edbeca3c32dda036b81446a4d9"></a>
 280 <div class="memitem">
 281 <div class="memproto">
 282       <table class="memname">
 283         <tr>
 284           <td class="memname">void configure </td>
 285           <td>(</td>
 286           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 287           <td class="paramname"><em>gx</em>, </td>
 288         </tr>
 289         <tr>
 290           <td class="paramkey"></td>
 291           <td></td>
 292           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 293           <td class="paramname"><em>gy</em>, </td>
 294         </tr>
 295         <tr>
 296           <td class="paramkey"></td>
 297           <td></td>
 298           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 299           <td class="paramname"><em>magnitude</em>, </td>
 300         </tr>
 301         <tr>
 302           <td class="paramkey"></td>
 303           <td></td>
 304           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 305           <td class="paramname"><em>phase</em>, </td>
 306         </tr>
 307         <tr>
 308           <td class="paramkey"></td>
 309           <td></td>
 310           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a7b3ec6413f000b02fdb4e39a951d9f8a">MagnitudeType</a>&#160;</td>
 311           <td class="paramname"><em>mag_type</em> = <code><a class="el" href="namespacearm__compute.xhtml#a7b3ec6413f000b02fdb4e39a951d9f8aad927ac799e8b24f80fc80d89b2eb7131">MagnitudeType::L2NORM</a></code>, </td>
 312         </tr>
 313         <tr>
 314           <td class="paramkey"></td>
 315           <td></td>
 316           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72">PhaseType</a>&#160;</td>
 317           <td class="paramname"><em>phase_type</em> = <code><a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72a6898b46a1cde8a1572e2722c44c5ab07">PhaseType::SIGNED</a></code>&#160;</td>
 318         </tr>
 319         <tr>
 320           <td></td>
 321           <td>)</td>
 322           <td></td><td></td>
 323         </tr>
 324       </table>
 325 </div><div class="memdoc">
 326
 327 <p>Initialise the kernel's input, output. </p>
 328 <dl class="section note"><dt>Note</dt><dd>At least one of output1 or output2 must be set.</dd></dl>
 329 <dl class="params"><dt>Parameters</dt><dd>
 330   <table class="params">
 331     <tr><td class="paramdir">[in]</td><td class="paramname">gx</td><td>The input gradient X tensor. Data types supported: S16. </td></tr>
 332     <tr><td class="paramdir">[in]</td><td class="paramname">gy</td><td>The input gradient Y tensor. Data types supported: S16. </td></tr>
 333     <tr><td class="paramdir">[out]</td><td class="paramname">magnitude</td><td>(Optional) The output tensor - Magnitude. Data types supported: S16. </td></tr>
 334     <tr><td class="paramdir">[out]</td><td class="paramname">phase</td><td>(Optional) The output tensor - Phase. Data types supported: U8. </td></tr>
 335     <tr><td class="paramdir">[in]</td><td class="paramname">mag_type</td><td>(Optional) Magnitude calculation type. Default: L2NORM. </td></tr>
 336     <tr><td class="paramdir">[in]</td><td class="paramname">phase_type</td><td>(Optional) Phase calculation type. Default: SIGNED. </td></tr>
 337   </table>
 338   </dd>
 339 </dl>
 340
 341 </div>
 342 </div>
 343 <a class="anchor" id="a11f21edc185eb160e844aa0c4ca9c29a"></a>
 344 <div class="memitem">
 345 <div class="memproto">
 346 <table class="mlabels">
 347   <tr>
 348   <td class="mlabels-left">
 349       <table class="memname">
 350         <tr>
 351           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a>&amp; operator= </td>
 352           <td>(</td>
 353           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&#160;</td>
 354           <td class="paramname"></td><td>)</td>
 355           <td></td>
 356         </tr>
 357       </table>
 358   </td>
 359   <td class="mlabels-right">
 360 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 361   </tr>
 362 </table>
 363 </div><div class="memdoc">
 364
 365 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
 366
 367 </div>
 368 </div>
 369 <a class="anchor" id="adb678b97316f473c8134729d88d22513"></a>
 370 <div class="memitem">
 371 <div class="memproto">
 372 <table class="mlabels">
 373   <tr>
 374   <td class="mlabels-left">
 375       <table class="memname">
 376         <tr>
 377           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a>&amp; operator= </td>
 378           <td>(</td>
 379           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a> &amp;&amp;&#160;</td>
 380           <td class="paramname"></td><td>)</td>
 381           <td></td>
 382         </tr>
 383       </table>
 384   </td>
 385   <td class="mlabels-right">
 386 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 387   </tr>
 388 </table>
 389 </div><div class="memdoc">
 390
 391 <p>Allow instances of this class to be moved. </p>
 392
 393 </div>
 394 </div>
 395 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
 396 <div class="memitem">
 397 <div class="memproto">
 398 <table class="mlabels">
 399   <tr>
 400   <td class="mlabels-left">
 401       <table class="memname">
 402         <tr>
 403           <td class="memname">void run </td>
 404           <td>(</td>
 405           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 406           <td class="paramname"><em>window</em>, </td>
 407         </tr>
 408         <tr>
 409           <td class="paramkey"></td>
 410           <td></td>
 411           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 412           <td class="paramname"><em>queue</em>&#160;</td>
 413         </tr>
 414         <tr>
 415           <td></td>
 416           <td>)</td>
 417           <td></td><td></td>
 418         </tr>
 419       </table>
 420   </td>
 421   <td class="mlabels-right">
 422 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 423   </tr>
 424 </table>
 425 </div><div class="memdoc">
 426
 427 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
 428 <dl class="section note"><dt>Note</dt><dd>The queue is <em>not</em> flushed by this method, and therefore the kernel will not have been executed by the time this method returns.</dd></dl>
 429 <dl class="params"><dt>Parameters</dt><dd>
 430   <table class="params">
 431     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a valid 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>
 432     <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
 433   </table>
 434   </dd>
 435 </dl>
 436
 437 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">ICLKernel</a>.</p>
 438
 439 </div>
 440 </div>
 441 <hr/>The documentation for this class was generated from the following file:<ul>
 442 <li>arm_compute/core/CL/kernels/<a class="el" href="_c_l_magnitude_phase_kernel_8h_source.xhtml">CLMagnitudePhaseKernel.h</a></li>
 443 </ul>
 444 </div><!-- contents -->
 445 </div><!-- doc-content -->
 446 <!-- start footer part -->
 447 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 448   <ul>
 449     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a></li>
 450     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
 451     <a href="http://www.doxygen.org/index.html">
 452     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 453   </ul>
 454 </div>
 455 </body>
 456 </html>