documentation/classarm__compute_1_1_n_e_channel_combine_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: NEChannelCombineKernel Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_channel_combine_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">NEChannelCombineKernel Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Interface for the channel combine kernel.
 126  <a href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for NEChannelCombineKernel:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_channel_combine_kernel__coll__graph.svg" width="199" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_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:aad5d3f2c658449874943ee6825a25715"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#aad5d3f2c658449874943ee6825a25715">NEChannelCombineKernel</a> ()</td></tr>
 142 <tr class="memdesc:aad5d3f2c658449874943ee6825a25715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aad5d3f2c658449874943ee6825a25715">More...</a><br /></td></tr>
 143 <tr class="separator:aad5d3f2c658449874943ee6825a25715"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a4ed070d1cc30490bb12259e2c47272b6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a4ed070d1cc30490bb12259e2c47272b6">NEChannelCombineKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;)=delete</td></tr>
 145 <tr class="memdesc:a4ed070d1cc30490bb12259e2c47272b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4ed070d1cc30490bb12259e2c47272b6">More...</a><br /></td></tr>
 146 <tr class="separator:a4ed070d1cc30490bb12259e2c47272b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:af7fa6b6b40f275e2f6f0afdf42aa6130"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#af7fa6b6b40f275e2f6f0afdf42aa6130">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;)=delete</td></tr>
 148 <tr class="memdesc:af7fa6b6b40f275e2f6f0afdf42aa6130"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#af7fa6b6b40f275e2f6f0afdf42aa6130">More...</a><br /></td></tr>
 149 <tr class="separator:af7fa6b6b40f275e2f6f0afdf42aa6130"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ad5a9384e02a7082b36ff31e9000d6ac6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#ad5a9384e02a7082b36ff31e9000d6ac6">NEChannelCombineKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;)=default</td></tr>
 151 <tr class="memdesc:ad5a9384e02a7082b36ff31e9000d6ac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ad5a9384e02a7082b36ff31e9000d6ac6">More...</a><br /></td></tr>
 152 <tr class="separator:ad5a9384e02a7082b36ff31e9000d6ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:a4dfea5b19ebe5e46148a63af9fdbc5db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a4dfea5b19ebe5e46148a63af9fdbc5db">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;)=default</td></tr>
 154 <tr class="memdesc:a4dfea5b19ebe5e46148a63af9fdbc5db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a4dfea5b19ebe5e46148a63af9fdbc5db">More...</a><br /></td></tr>
 155 <tr class="separator:a4dfea5b19ebe5e46148a63af9fdbc5db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a3b991bc19cdd8e7fb06de869a43c7799"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a3b991bc19cdd8e7fb06de869a43c7799">~NEChannelCombineKernel</a> ()=default</td></tr>
 157 <tr class="memdesc:a3b991bc19cdd8e7fb06de869a43c7799"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a3b991bc19cdd8e7fb06de869a43c7799">More...</a><br /></td></tr>
 158 <tr class="separator:a3b991bc19cdd8e7fb06de869a43c7799"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:a39ee07b7b99e5ede71d07248b2c8ec76"><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_channel_combine_kernel.xhtml#a39ee07b7b99e5ede71d07248b2c8ec76">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *plane0, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *plane1, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *plane2, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *plane3, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output)</td></tr>
 160 <tr class="memdesc:a39ee07b7b99e5ede71d07248b2c8ec76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure function's inputs and outputs.  <a href="#a39ee07b7b99e5ede71d07248b2c8ec76">More...</a><br /></td></tr>
 161 <tr class="separator:a39ee07b7b99e5ede71d07248b2c8ec76"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:a2152066cff4fb48815bb07a360086ddc"><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_channel_combine_kernel.xhtml#a2152066cff4fb48815bb07a360086ddc">configure</a> (const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *plane0, const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *plane1, const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *plane2, <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml">IMultiImage</a> *output)</td></tr>
 163 <tr class="memdesc:a2152066cff4fb48815bb07a360086ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure function's inputs and outputs.  <a href="#a2152066cff4fb48815bb07a360086ddc">More...</a><br /></td></tr>
 164 <tr class="separator:a2152066cff4fb48815bb07a360086ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <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_channel_combine_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>
 166 <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>
 167 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a4370ae5fda7bd455a171fc8ed4d3f283">is_parallelisable</a> () const override</td></tr>
 169 <tr class="memdesc:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#a4370ae5fda7bd455a171fc8ed4d3f283">More...</a><br /></td></tr>
 170 <tr class="separator:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <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>
 172 <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>
 173 <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>
 174 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <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>
 176 <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>
 177 <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>
 178 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <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>
 180 <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>
 181 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <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>
 183 <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>
 184 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <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>
 186 <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>
 187 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 </table>
 189 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 190 <div class="textblock"><p>Interface for the channel combine kernel. </p>
 191
 192 <p>Definition at line <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a>.</p>
 193 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 194 <a class="anchor" id="aad5d3f2c658449874943ee6825a25715"></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_channel_combine_kernel.xhtml">NEChannelCombineKernel</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_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 210
 211 </div>
 212 </div>
 213 <a class="anchor" id="a4ed070d1cc30490bb12259e2c47272b6"></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_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 222           <td>(</td>
 223           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td>
 224           <td class="paramname"></td><td>)</td>
 225           <td></td>
 226         </tr>
 227       </table>
 228   </td>
 229   <td class="mlabels-right">
 230 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 231   </tr>
 232 </table>
 233 </div><div class="memdoc">
 234
 235 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 236
 237 </div>
 238 </div>
 239 <a class="anchor" id="ad5a9384e02a7082b36ff31e9000d6ac6"></a>
 240 <div class="memitem">
 241 <div class="memproto">
 242 <table class="mlabels">
 243   <tr>
 244   <td class="mlabels-left">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 248           <td>(</td>
 249           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;&#160;</td>
 250           <td class="paramname"></td><td>)</td>
 251           <td></td>
 252         </tr>
 253       </table>
 254   </td>
 255   <td class="mlabels-right">
 256 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 257   </tr>
 258 </table>
 259 </div><div class="memdoc">
 260
 261 <p>Allow instances of this class to be moved. </p>
 262
 263 </div>
 264 </div>
 265 <a class="anchor" id="a3b991bc19cdd8e7fb06de869a43c7799"></a>
 266 <div class="memitem">
 267 <div class="memproto">
 268 <table class="mlabels">
 269   <tr>
 270   <td class="mlabels-left">
 271       <table class="memname">
 272         <tr>
 273           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 274           <td>(</td>
 275           <td class="paramname"></td><td>)</td>
 276           <td></td>
 277         </tr>
 278       </table>
 279   </td>
 280   <td class="mlabels-right">
 281 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 282   </tr>
 283 </table>
 284 </div><div class="memdoc">
 285
 286 <p>Default destructor. </p>
 287
 288 <p>Referenced by <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 289
 290 </div>
 291 </div>
 292 <h2 class="groupheader">Member Function Documentation</h2>
 293 <a class="anchor" id="a39ee07b7b99e5ede71d07248b2c8ec76"></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>plane0</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>plane1</em>, </td>
 308         </tr>
 309         <tr>
 310           <td class="paramkey"></td>
 311           <td></td>
 312           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 313           <td class="paramname"><em>plane2</em>, </td>
 314         </tr>
 315         <tr>
 316           <td class="paramkey"></td>
 317           <td></td>
 318           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 319           <td class="paramname"><em>plane3</em>, </td>
 320         </tr>
 321         <tr>
 322           <td class="paramkey"></td>
 323           <td></td>
 324           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 325           <td class="paramname"><em>output</em>&#160;</td>
 326         </tr>
 327         <tr>
 328           <td></td>
 329           <td>)</td>
 330           <td></td><td></td>
 331         </tr>
 332       </table>
 333 </div><div class="memdoc">
 334
 335 <p>Configure function's inputs and outputs. </p>
 336 <dl class="params"><dt>Parameters</dt><dd>
 337   <table class="params">
 338     <tr><td class="paramdir">[in]</td><td class="paramname">plane0</td><td>The 2D plane that forms channel 0. Data type supported: U8 </td></tr>
 339     <tr><td class="paramdir">[in]</td><td class="paramname">plane1</td><td>The 2D plane that forms channel 1. Data type supported: U8 </td></tr>
 340     <tr><td class="paramdir">[in]</td><td class="paramname">plane2</td><td>The 2D plane that forms channel 2. Data type supported: U8 </td></tr>
 341     <tr><td class="paramdir">[in]</td><td class="paramname">plane3</td><td>The 2D plane that forms channel 3. Data type supported: U8 </td></tr>
 342     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The single planar output tensor. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422 </td></tr>
 343   </table>
 344   </dd>
 345 </dl>
 346
 347 <p>Referenced by <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 348
 349 </div>
 350 </div>
 351 <a class="anchor" id="a2152066cff4fb48815bb07a360086ddc"></a>
 352 <div class="memitem">
 353 <div class="memproto">
 354       <table class="memname">
 355         <tr>
 356           <td class="memname">void configure </td>
 357           <td>(</td>
 358           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 359           <td class="paramname"><em>plane0</em>, </td>
 360         </tr>
 361         <tr>
 362           <td class="paramkey"></td>
 363           <td></td>
 364           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 365           <td class="paramname"><em>plane1</em>, </td>
 366         </tr>
 367         <tr>
 368           <td class="paramkey"></td>
 369           <td></td>
 370           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 371           <td class="paramname"><em>plane2</em>, </td>
 372         </tr>
 373         <tr>
 374           <td class="paramkey"></td>
 375           <td></td>
 376           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_multi_image.xhtml">IMultiImage</a> *&#160;</td>
 377           <td class="paramname"><em>output</em>&#160;</td>
 378         </tr>
 379         <tr>
 380           <td></td>
 381           <td>)</td>
 382           <td></td><td></td>
 383         </tr>
 384       </table>
 385 </div><div class="memdoc">
 386
 387 <p>Configure function's inputs and outputs. </p>
 388 <dl class="params"><dt>Parameters</dt><dd>
 389   <table class="params">
 390     <tr><td class="paramdir">[in]</td><td class="paramname">plane0</td><td>The 2D plane that forms channel 0. Data type supported: U8 </td></tr>
 391     <tr><td class="paramdir">[in]</td><td class="paramname">plane1</td><td>The 2D plane that forms channel 1. Data type supported: U8 </td></tr>
 392     <tr><td class="paramdir">[in]</td><td class="paramname">plane2</td><td>The 2D plane that forms channel 2. Data type supported: U8 </td></tr>
 393     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The multi planar output tensor. Formats supported: NV12/NV21/IYUV/YUV444 </td></tr>
 394   </table>
 395   </dd>
 396 </dl>
 397
 398 </div>
 399 </div>
 400 <a class="anchor" id="a4370ae5fda7bd455a171fc8ed4d3f283"></a>
 401 <div class="memitem">
 402 <div class="memproto">
 403 <table class="mlabels">
 404   <tr>
 405   <td class="mlabels-left">
 406       <table class="memname">
 407         <tr>
 408           <td class="memname">bool is_parallelisable </td>
 409           <td>(</td>
 410           <td class="paramname"></td><td>)</td>
 411           <td> const</td>
 412         </tr>
 413       </table>
 414   </td>
 415   <td class="mlabels-right">
 416 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 417   </tr>
 418 </table>
 419 </div><div class="memdoc">
 420
 421 <p>Indicates whether or not the kernel is parallelisable. </p>
 422 <p>If the kernel is parallelisable then 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> can be split into sub-windows which can then be run in parallel.</p>
 423 <p>If the kernel is not parallelisable then only 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> can be passed to <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82" title="Execute the kernel on the passed window. ">run()</a></p>
 424 <dl class="section return"><dt>Returns</dt><dd>True if the kernel is parallelisable </dd></dl>
 425
 426 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">IKernel</a>.</p>
 427
 428 <p>Referenced by <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 429
 430 </div>
 431 </div>
 432 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
 433 <div class="memitem">
 434 <div class="memproto">
 435 <table class="mlabels">
 436   <tr>
 437   <td class="mlabels-left">
 438       <table class="memname">
 439         <tr>
 440           <td class="memname">const char* name </td>
 441           <td>(</td>
 442           <td class="paramname"></td><td>)</td>
 443           <td> const</td>
 444         </tr>
 445       </table>
 446   </td>
 447   <td class="mlabels-right">
 448 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 449   </tr>
 450 </table>
 451 </div><div class="memdoc">
 452
 453 <p>Name of the kernel. </p>
 454 <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>
 455
 456 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
 457
 458 <p>Definition at line <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a>.</p>
 459
 460 <p>References <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a39ee07b7b99e5ede71d07248b2c8ec76">NEChannelCombineKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a4370ae5fda7bd455a171fc8ed4d3f283">NEChannelCombineKernel::is_parallelisable()</a>, <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#aad5d3f2c658449874943ee6825a25715">NEChannelCombineKernel::NEChannelCombineKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#af7fa6b6b40f275e2f6f0afdf42aa6130">NEChannelCombineKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEChannelCombineKernel::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_channel_combine_kernel.xhtml#a3b991bc19cdd8e7fb06de869a43c7799">NEChannelCombineKernel::~NEChannelCombineKernel()</a>.</p>
 461 <div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEChannelCombineKernel&quot;</span>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    }</div></div><!-- fragment -->
 462 </div>
 463 </div>
 464 <a class="anchor" id="af7fa6b6b40f275e2f6f0afdf42aa6130"></a>
 465 <div class="memitem">
 466 <div class="memproto">
 467 <table class="mlabels">
 468   <tr>
 469   <td class="mlabels-left">
 470       <table class="memname">
 471         <tr>
 472           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a>&amp; operator= </td>
 473           <td>(</td>
 474           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td>
 475           <td class="paramname"></td><td>)</td>
 476           <td></td>
 477         </tr>
 478       </table>
 479   </td>
 480   <td class="mlabels-right">
 481 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 482   </tr>
 483 </table>
 484 </div><div class="memdoc">
 485
 486 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 487
 488 <p>Referenced by <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 489
 490 </div>
 491 </div>
 492 <a class="anchor" id="a4dfea5b19ebe5e46148a63af9fdbc5db"></a>
 493 <div class="memitem">
 494 <div class="memproto">
 495 <table class="mlabels">
 496   <tr>
 497   <td class="mlabels-left">
 498       <table class="memname">
 499         <tr>
 500           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a>&amp; operator= </td>
 501           <td>(</td>
 502           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;&#160;</td>
 503           <td class="paramname"></td><td>)</td>
 504           <td></td>
 505         </tr>
 506       </table>
 507   </td>
 508   <td class="mlabels-right">
 509 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 510   </tr>
 511 </table>
 512 </div><div class="memdoc">
 513
 514 <p>Allow instances of this class to be moved. </p>
 515
 516 </div>
 517 </div>
 518 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
 519 <div class="memitem">
 520 <div class="memproto">
 521 <table class="mlabels">
 522   <tr>
 523   <td class="mlabels-left">
 524       <table class="memname">
 525         <tr>
 526           <td class="memname">void run </td>
 527           <td>(</td>
 528           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 529           <td class="paramname"><em>window</em>, </td>
 530         </tr>
 531         <tr>
 532           <td class="paramkey"></td>
 533           <td></td>
 534           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
 535           <td class="paramname"><em>info</em>&#160;</td>
 536         </tr>
 537         <tr>
 538           <td></td>
 539           <td>)</td>
 540           <td></td><td></td>
 541         </tr>
 542       </table>
 543   </td>
 544   <td class="mlabels-right">
 545 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 546   </tr>
 547 </table>
 548 </div><div class="memdoc">
 549
 550 <p>Execute the kernel on the passed window. </p>
 551 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#a4370ae5fda7bd455a171fc8ed4d3f283" 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>
 552 <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>
 553 <dd>
 554 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
 555 <dl class="params"><dt>Parameters</dt><dd>
 556   <table class="params">
 557     <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>
 558     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
 559   </table>
 560   </dd>
 561 </dl>
 562
 563 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
 564
 565 <p>Referenced by <a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml#l00042">NEChannelCombineKernel::name()</a>.</p>
 566
 567 </div>
 568 </div>
 569 <hr/>The documentation for this class was generated from the following file:<ul>
 570 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a></li>
 571 </ul>
 572 </div><!-- contents -->
 573 </div><!-- doc-content -->
 574 <!-- start footer part -->
 575 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 576   <ul>
 577     <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_channel_combine_kernel.xhtml">NEChannelCombineKernel</a></li>
 578     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
 579     <a href="http://www.doxygen.org/index.html">
 580     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 581   </ul>
 582 </div>
 583 </body>
 584 </html>