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>ARM 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.03.1</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_n_e_channel_combine_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">NEChannelCombineKernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Interface for the channel combine kernel.
 125  <a href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for NEChannelCombineKernel:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_channel_combine_kernel__coll__graph.svg" width="190" 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: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>
 138 <tr class="memdesc:aad5d3f2c658449874943ee6825a25715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aad5d3f2c658449874943ee6825a25715">More...</a><br /></td></tr>
 139 <tr class="separator:aad5d3f2c658449874943ee6825a25715"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:a4ed070d1cc30490bb12259e2c47272b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <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>
 144 <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>
 145 <tr class="separator:af7fa6b6b40f275e2f6f0afdf42aa6130"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <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>
 147 <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>
 148 <tr class="separator:ad5a9384e02a7082b36ff31e9000d6ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <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>
 151 <tr class="separator:a4dfea5b19ebe5e46148a63af9fdbc5db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <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>
 153 <tr class="memdesc:a3b991bc19cdd8e7fb06de869a43c7799"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a3b991bc19cdd8e7fb06de869a43c7799">More...</a><br /></td></tr>
 154 <tr class="separator:a3b991bc19cdd8e7fb06de869a43c7799"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <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>
 156 <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>
 157 <tr class="separator:a39ee07b7b99e5ede71d07248b2c8ec76"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <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>
 159 <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>
 160 <tr class="separator:a2152066cff4fb48815bb07a360086ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><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#a8fd12b95bdde3f93db96bc9b1598db69">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>) override</td></tr>
 162 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
 163 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <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>
 165 <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>
 166 <tr class="separator:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <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>
 168 <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>
 169 <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>
 170 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <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>
 172 <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>
 173 <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>
 174 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <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>
 176 <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>
 177 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <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>
 179 <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>
 180 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <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>
 182 <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>
 183 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 </table>
 185 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 186 <div class="textblock"><p>Interface for the channel combine kernel. </p>
 187
 188 <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>
 189 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 190 <a class="anchor" id="aad5d3f2c658449874943ee6825a25715"></a>
 191 <div class="memitem">
 192 <div class="memproto">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 196           <td>(</td>
 197           <td class="paramname"></td><td>)</td>
 198           <td></td>
 199         </tr>
 200       </table>
 201 </div><div class="memdoc">
 202
 203 <p>Default constructor. </p>
 204
 205 </div>
 206 </div>
 207 <a class="anchor" id="a4ed070d1cc30490bb12259e2c47272b6"></a>
 208 <div class="memitem">
 209 <div class="memproto">
 210 <table class="mlabels">
 211   <tr>
 212   <td class="mlabels-left">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 216           <td>(</td>
 217           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td>
 218           <td class="paramname"></td><td>)</td>
 219           <td></td>
 220         </tr>
 221       </table>
 222   </td>
 223   <td class="mlabels-right">
 224 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 225   </tr>
 226 </table>
 227 </div><div class="memdoc">
 228
 229 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 230
 231 </div>
 232 </div>
 233 <a class="anchor" id="ad5a9384e02a7082b36ff31e9000d6ac6"></a>
 234 <div class="memitem">
 235 <div class="memproto">
 236 <table class="mlabels">
 237   <tr>
 238   <td class="mlabels-left">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 242           <td>(</td>
 243           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;&#160;</td>
 244           <td class="paramname"></td><td>)</td>
 245           <td></td>
 246         </tr>
 247       </table>
 248   </td>
 249   <td class="mlabels-right">
 250 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 251   </tr>
 252 </table>
 253 </div><div class="memdoc">
 254
 255 <p>Allow instances of this class to be moved. </p>
 256
 257 </div>
 258 </div>
 259 <a class="anchor" id="a3b991bc19cdd8e7fb06de869a43c7799"></a>
 260 <div class="memitem">
 261 <div class="memproto">
 262 <table class="mlabels">
 263   <tr>
 264   <td class="mlabels-left">
 265       <table class="memname">
 266         <tr>
 267           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> </td>
 268           <td>(</td>
 269           <td class="paramname"></td><td>)</td>
 270           <td></td>
 271         </tr>
 272       </table>
 273   </td>
 274   <td class="mlabels-right">
 275 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 276   </tr>
 277 </table>
 278 </div><div class="memdoc">
 279
 280 <p>Default destructor. </p>
 281
 282 </div>
 283 </div>
 284 <h2 class="groupheader">Member Function Documentation</h2>
 285 <a class="anchor" id="a39ee07b7b99e5ede71d07248b2c8ec76"></a>
 286 <div class="memitem">
 287 <div class="memproto">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname">void configure </td>
 291           <td>(</td>
 292           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 293           <td class="paramname"><em>plane0</em>, </td>
 294         </tr>
 295         <tr>
 296           <td class="paramkey"></td>
 297           <td></td>
 298           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 299           <td class="paramname"><em>plane1</em>, </td>
 300         </tr>
 301         <tr>
 302           <td class="paramkey"></td>
 303           <td></td>
 304           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 305           <td class="paramname"><em>plane2</em>, </td>
 306         </tr>
 307         <tr>
 308           <td class="paramkey"></td>
 309           <td></td>
 310           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 311           <td class="paramname"><em>plane3</em>, </td>
 312         </tr>
 313         <tr>
 314           <td class="paramkey"></td>
 315           <td></td>
 316           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 317           <td class="paramname"><em>output</em>&#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>Configure function's inputs and outputs. </p>
 328 <dl class="params"><dt>Parameters</dt><dd>
 329   <table class="params">
 330     <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>
 331     <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>
 332     <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>
 333     <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>
 334     <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>
 335   </table>
 336   </dd>
 337 </dl>
 338
 339 </div>
 340 </div>
 341 <a class="anchor" id="a2152066cff4fb48815bb07a360086ddc"></a>
 342 <div class="memitem">
 343 <div class="memproto">
 344       <table class="memname">
 345         <tr>
 346           <td class="memname">void configure </td>
 347           <td>(</td>
 348           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 349           <td class="paramname"><em>plane0</em>, </td>
 350         </tr>
 351         <tr>
 352           <td class="paramkey"></td>
 353           <td></td>
 354           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 355           <td class="paramname"><em>plane1</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 361           <td class="paramname"><em>plane2</em>, </td>
 362         </tr>
 363         <tr>
 364           <td class="paramkey"></td>
 365           <td></td>
 366           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_multi_image.xhtml">IMultiImage</a> *&#160;</td>
 367           <td class="paramname"><em>output</em>&#160;</td>
 368         </tr>
 369         <tr>
 370           <td></td>
 371           <td>)</td>
 372           <td></td><td></td>
 373         </tr>
 374       </table>
 375 </div><div class="memdoc">
 376
 377 <p>Configure function's inputs and outputs. </p>
 378 <dl class="params"><dt>Parameters</dt><dd>
 379   <table class="params">
 380     <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>
 381     <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>
 382     <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>
 383     <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>
 384   </table>
 385   </dd>
 386 </dl>
 387
 388 </div>
 389 </div>
 390 <a class="anchor" id="a4370ae5fda7bd455a171fc8ed4d3f283"></a>
 391 <div class="memitem">
 392 <div class="memproto">
 393 <table class="mlabels">
 394   <tr>
 395   <td class="mlabels-left">
 396       <table class="memname">
 397         <tr>
 398           <td class="memname">bool is_parallelisable </td>
 399           <td>(</td>
 400           <td class="paramname"></td><td>)</td>
 401           <td> const</td>
 402         </tr>
 403       </table>
 404   </td>
 405   <td class="mlabels-right">
 406 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 407   </tr>
 408 </table>
 409 </div><div class="memdoc">
 410
 411 <p>Indicates whether or not the kernel is parallelisable. </p>
 412 <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>
 413 <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#a8fd12b95bdde3f93db96bc9b1598db69" title="Execute the kernel on the passed window. ">run()</a></p>
 414 <dl class="section return"><dt>Returns</dt><dd>True if the kernel is parallelisable </dd></dl>
 415
 416 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">IKernel</a>.</p>
 417
 418 </div>
 419 </div>
 420 <a class="anchor" id="af7fa6b6b40f275e2f6f0afdf42aa6130"></a>
 421 <div class="memitem">
 422 <div class="memproto">
 423 <table class="mlabels">
 424   <tr>
 425   <td class="mlabels-left">
 426       <table class="memname">
 427         <tr>
 428           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a>&amp; operator= </td>
 429           <td>(</td>
 430           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&#160;</td>
 431           <td class="paramname"></td><td>)</td>
 432           <td></td>
 433         </tr>
 434       </table>
 435   </td>
 436   <td class="mlabels-right">
 437 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 438   </tr>
 439 </table>
 440 </div><div class="memdoc">
 441
 442 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 443
 444 </div>
 445 </div>
 446 <a class="anchor" id="a4dfea5b19ebe5e46148a63af9fdbc5db"></a>
 447 <div class="memitem">
 448 <div class="memproto">
 449 <table class="mlabels">
 450   <tr>
 451   <td class="mlabels-left">
 452       <table class="memname">
 453         <tr>
 454           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a>&amp; operator= </td>
 455           <td>(</td>
 456           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_channel_combine_kernel.xhtml">NEChannelCombineKernel</a> &amp;&amp;&#160;</td>
 457           <td class="paramname"></td><td>)</td>
 458           <td></td>
 459         </tr>
 460       </table>
 461   </td>
 462   <td class="mlabels-right">
 463 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 464   </tr>
 465 </table>
 466 </div><div class="memdoc">
 467
 468 <p>Allow instances of this class to be moved. </p>
 469
 470 </div>
 471 </div>
 472 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
 473 <div class="memitem">
 474 <div class="memproto">
 475 <table class="mlabels">
 476   <tr>
 477   <td class="mlabels-left">
 478       <table class="memname">
 479         <tr>
 480           <td class="memname">void run </td>
 481           <td>(</td>
 482           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 483           <td class="paramname"><em>window</em></td><td>)</td>
 484           <td></td>
 485         </tr>
 486       </table>
 487   </td>
 488   <td class="mlabels-right">
 489 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 490   </tr>
 491 </table>
 492 </div><div class="memdoc">
 493
 494 <p>Execute the kernel on the passed window. </p>
 495 <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>
 496 <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>
 497 <dd>
 498 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
 499 <dl class="params"><dt>Parameters</dt><dd>
 500   <table class="params">
 501     <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>
 502   </table>
 503   </dd>
 504 </dl>
 505
 506 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
 507
 508 </div>
 509 </div>
 510 <hr/>The documentation for this class was generated from the following file:<ul>
 511 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_channel_combine_kernel_8h_source.xhtml">NEChannelCombineKernel.h</a></li>
 512 </ul>
 513 </div><!-- contents -->
 514 </div><!-- doc-content -->
 515 <!-- start footer part -->
 516 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 517   <ul>
 518     <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>
 519     <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
 520     <a href="http://www.doxygen.org/index.html">
 521     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 522   </ul>
 523 </div>
 524 </body>
 525 </html>