arm_compute v18.01
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_p_p_permute_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: CPPPermuteKernel 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.01</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_c_p_p_permute_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> &#124;
120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
121   <div class="headertitle">
122 <div class="title">CPPPermuteKernel Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>CPP kernel to perform tensor permutation.  
127  <a href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_c_p_p_permute_kernel_8h_source.xhtml">CPPPermuteKernel.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for CPPPermuteKernel:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_p_p_permute_kernel__coll__graph.svg" width="152" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
134 </div>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <tr class="memitem:ad95ff8fce8fe09a6b8f7d54d746e38fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#ad95ff8fce8fe09a6b8f7d54d746e38fb">CPPPermuteKernel</a> ()</td></tr>
140 <tr class="memdesc:ad95ff8fce8fe09a6b8f7d54d746e38fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ad95ff8fce8fe09a6b8f7d54d746e38fb">More...</a><br /></td></tr>
141 <tr class="separator:ad95ff8fce8fe09a6b8f7d54d746e38fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a34c3007dbd5acec7d1d1d9b49ebc461a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#a34c3007dbd5acec7d1d1d9b49ebc461a">CPPPermuteKernel</a> (const <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;)=delete</td></tr>
143 <tr class="memdesc:a34c3007dbd5acec7d1d1d9b49ebc461a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a34c3007dbd5acec7d1d1d9b49ebc461a">More...</a><br /></td></tr>
144 <tr class="separator:a34c3007dbd5acec7d1d1d9b49ebc461a"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:a2c787fefc7ee52b787ffd59a50960e2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#a2c787fefc7ee52b787ffd59a50960e2c">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;)=delete</td></tr>
146 <tr class="memdesc:a2c787fefc7ee52b787ffd59a50960e2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a2c787fefc7ee52b787ffd59a50960e2c">More...</a><br /></td></tr>
147 <tr class="separator:a2c787fefc7ee52b787ffd59a50960e2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a67c68efcc0e4c376502c9f014c5ecd27"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#a67c68efcc0e4c376502c9f014c5ecd27">CPPPermuteKernel</a> (<a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&amp;)=default</td></tr>
149 <tr class="memdesc:a67c68efcc0e4c376502c9f014c5ecd27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a67c68efcc0e4c376502c9f014c5ecd27">More...</a><br /></td></tr>
150 <tr class="separator:a67c68efcc0e4c376502c9f014c5ecd27"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:a590793a033bdef7868ed0454d91131ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#a590793a033bdef7868ed0454d91131ee">operator=</a> (<a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&amp;)=default</td></tr>
152 <tr class="memdesc:a590793a033bdef7868ed0454d91131ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a590793a033bdef7868ed0454d91131ee">More...</a><br /></td></tr>
153 <tr class="separator:a590793a033bdef7868ed0454d91131ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:ab1ee61e7cba8829906926ec41213dfdc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#ab1ee61e7cba8829906926ec41213dfdc">~CPPPermuteKernel</a> ()=default</td></tr>
155 <tr class="memdesc:ab1ee61e7cba8829906926ec41213dfdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#ab1ee61e7cba8829906926ec41213dfdc">More...</a><br /></td></tr>
156 <tr class="separator:ab1ee61e7cba8829906926ec41213dfdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:a93c836ab36443b23753d99495761daf7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#a93c836ab36443b23753d99495761daf7">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, const <a class="el" href="namespacearm__compute.xhtml#a33e65be485104e2e9e69fca551d6f492">PermutationVector</a> &amp;perm)</td></tr>
158 <tr class="memdesc:a93c836ab36443b23753d99495761daf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output of the kernel.  <a href="#a93c836ab36443b23753d99495761daf7">More...</a><br /></td></tr>
159 <tr class="separator:a93c836ab36443b23753d99495761daf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <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_c_p_p_permute_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>
161 <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>
162 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <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>
164 <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>
165 <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>
166 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <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>
168 <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>
169 <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>
170 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <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>
172 <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>
173 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <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>
175 <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>
176 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <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>
178 <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>
179 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <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>
181 <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>
182 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 </table><table class="memberdecls">
184 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
185 Static Public Member Functions</h2></td></tr>
186 <tr class="memitem:aa3c4cd2bc022be50064a001ee92750cb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml#aa3c4cd2bc022be50064a001ee92750cb">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output, const <a class="el" href="namespacearm__compute.xhtml#a33e65be485104e2e9e69fca551d6f492">PermutationVector</a> &amp;perm)</td></tr>
187 <tr class="memdesc:aa3c4cd2bc022be50064a001ee92750cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a>.  <a href="#aa3c4cd2bc022be50064a001ee92750cb">More...</a><br /></td></tr>
188 <tr class="separator:aa3c4cd2bc022be50064a001ee92750cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
189 </table>
190 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
191 <div class="textblock"><p>CPP kernel to perform tensor permutation. </p>
192 <p>Permutes given a permutation vector </p>
193
194 <p>Definition at line <a class="el" href="_c_p_p_permute_kernel_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_p_p_permute_kernel_8h_source.xhtml">CPPPermuteKernel.h</a>.</p>
195 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
196 <a class="anchor" id="ad95ff8fce8fe09a6b8f7d54d746e38fb"></a>
197 <div class="memitem">
198 <div class="memproto">
199       <table class="memname">
200         <tr>
201           <td class="memname"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> </td>
202           <td>(</td>
203           <td class="paramname"></td><td>)</td>
204           <td></td>
205         </tr>
206       </table>
207 </div><div class="memdoc">
208
209 <p>Default constructor. </p>
210
211 </div>
212 </div>
213 <a class="anchor" id="a34c3007dbd5acec7d1d1d9b49ebc461a"></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_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> </td>
222           <td>(</td>
223           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</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="a67c68efcc0e4c376502c9f014c5ecd27"></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_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> </td>
248           <td>(</td>
249           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</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="ab1ee61e7cba8829906926ec41213dfdc"></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_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</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 </div>
289 </div>
290 <h2 class="groupheader">Member Function Documentation</h2>
291 <a class="anchor" id="a93c836ab36443b23753d99495761daf7"></a>
292 <div class="memitem">
293 <div class="memproto">
294       <table class="memname">
295         <tr>
296           <td class="memname">void configure </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>input</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_tensor.xhtml">ITensor</a> *&#160;</td>
305           <td class="paramname"><em>output</em>, </td>
306         </tr>
307         <tr>
308           <td class="paramkey"></td>
309           <td></td>
310           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#a33e65be485104e2e9e69fca551d6f492">PermutationVector</a> &amp;&#160;</td>
311           <td class="paramname"><em>perm</em>&#160;</td>
312         </tr>
313         <tr>
314           <td></td>
315           <td>)</td>
316           <td></td><td></td>
317         </tr>
318       </table>
319 </div><div class="memdoc">
320
321 <p>Set the input and output of the kernel. </p>
322 <dl class="params"><dt>Parameters</dt><dd>
323   <table class="params">
324     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The input tensor to permute. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32 </td></tr>
325     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The output tensor. Data types supported: Same as <code>input</code> </td></tr>
326     <tr><td class="paramdir">[in]</td><td class="paramname">perm</td><td>Permutation vector </td></tr>
327   </table>
328   </dd>
329 </dl>
330
331 </div>
332 </div>
333 <a class="anchor" id="a2c787fefc7ee52b787ffd59a50960e2c"></a>
334 <div class="memitem">
335 <div class="memproto">
336 <table class="mlabels">
337   <tr>
338   <td class="mlabels-left">
339       <table class="memname">
340         <tr>
341           <td class="memname"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a>&amp; operator= </td>
342           <td>(</td>
343           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&#160;</td>
344           <td class="paramname"></td><td>)</td>
345           <td></td>
346         </tr>
347       </table>
348   </td>
349   <td class="mlabels-right">
350 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
351   </tr>
352 </table>
353 </div><div class="memdoc">
354
355 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
356
357 </div>
358 </div>
359 <a class="anchor" id="a590793a033bdef7868ed0454d91131ee"></a>
360 <div class="memitem">
361 <div class="memproto">
362 <table class="mlabels">
363   <tr>
364   <td class="mlabels-left">
365       <table class="memname">
366         <tr>
367           <td class="memname"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a>&amp; operator= </td>
368           <td>(</td>
369           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a> &amp;&amp;&#160;</td>
370           <td class="paramname"></td><td>)</td>
371           <td></td>
372         </tr>
373       </table>
374   </td>
375   <td class="mlabels-right">
376 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
377   </tr>
378 </table>
379 </div><div class="memdoc">
380
381 <p>Allow instances of this class to be moved. </p>
382
383 </div>
384 </div>
385 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
386 <div class="memitem">
387 <div class="memproto">
388 <table class="mlabels">
389   <tr>
390   <td class="mlabels-left">
391       <table class="memname">
392         <tr>
393           <td class="memname">void run </td>
394           <td>(</td>
395           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
396           <td class="paramname"><em>window</em>, </td>
397         </tr>
398         <tr>
399           <td class="paramkey"></td>
400           <td></td>
401           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
402           <td class="paramname"><em>info</em>&#160;</td>
403         </tr>
404         <tr>
405           <td></td>
406           <td>)</td>
407           <td></td><td></td>
408         </tr>
409       </table>
410   </td>
411   <td class="mlabels-right">
412 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
413   </tr>
414 </table>
415 </div><div class="memdoc">
416
417 <p>Execute the kernel on the passed window. </p>
418 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
419 <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>
420 <dd>
421 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
422 <dl class="params"><dt>Parameters</dt><dd>
423   <table class="params">
424     <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>
425     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
426   </table>
427   </dd>
428 </dl>
429
430 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
431
432 </div>
433 </div>
434 <a class="anchor" id="aa3c4cd2bc022be50064a001ee92750cb"></a>
435 <div class="memitem">
436 <div class="memproto">
437 <table class="mlabels">
438   <tr>
439   <td class="mlabels-left">
440       <table class="memname">
441         <tr>
442           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
443           <td>(</td>
444           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
445           <td class="paramname"><em>input</em>, </td>
446         </tr>
447         <tr>
448           <td class="paramkey"></td>
449           <td></td>
450           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
451           <td class="paramname"><em>output</em>, </td>
452         </tr>
453         <tr>
454           <td class="paramkey"></td>
455           <td></td>
456           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#a33e65be485104e2e9e69fca551d6f492">PermutationVector</a> &amp;&#160;</td>
457           <td class="paramname"><em>perm</em>&#160;</td>
458         </tr>
459         <tr>
460           <td></td>
461           <td>)</td>
462           <td></td><td></td>
463         </tr>
464       </table>
465   </td>
466   <td class="mlabels-right">
467 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
468   </tr>
469 </table>
470 </div><div class="memdoc">
471
472 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_p_p_permute_kernel.xhtml">CPPPermuteKernel</a>. </p>
473 <dl class="params"><dt>Parameters</dt><dd>
474   <table class="params">
475     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The input tensor to permute. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32 </td></tr>
476     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>The output tensor. Data types supported: Same as <code>input</code> </td></tr>
477     <tr><td class="paramdir">[in]</td><td class="paramname">perm</td><td>Permutation vector</td></tr>
478   </table>
479   </dd>
480 </dl>
481 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
482
483 </div>
484 </div>
485 <hr/>The documentation for this class was generated from the following file:<ul>
486 <li>arm_compute/core/CPP/kernels/<a class="el" href="_c_p_p_permute_kernel_8h_source.xhtml">CPPPermuteKernel.h</a></li>
487 </ul>
488 </div><!-- contents -->
489 </div><!-- doc-content -->
490 <!-- start footer part -->
491 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
492   <ul>
493     <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_p_p_permute_kernel.xhtml">CPPPermuteKernel</a></li>
494     <li class="footer">Generated on Wed Jan 24 2018 14:30:45 for Compute Library by
495     <a href="http://www.doxygen.org/index.html">
496     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
497   </ul>
498 </div>
499 </body>
500 </html>