Compute Library
 21.05
ClPermuteKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CL_PERMUTE_KERNEL_H
25 #define ARM_COMPUTE_CL_PERMUTE_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** OpenCL kernel to perform tensor permutation.
38  *
39  * Permutes given a permutation vector
40  */
41 class ClPermuteKernel : public IClKernel
42 {
43 public:
44  /** Default constructor */
45  ClPermuteKernel() = default;
47  /** Set the src and dst of the kernel.
48  *
49  * @note Arbitrary permutation vectors are supported with rank not greater than 4
50  *
51  * @param[in] compile_context The compile context to be used.
52  * @param[in] src The src tensor info. Data types supported: All.
53  * @param[in] dst The dst tensor info. Data types supported: Same as @p src
54  * @param[in] perm Permutation vector
55  */
56  void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm);
57  /** Static function to check if given info will lead to a valid configuration of @ref ClPermuteKernel
58  *
59  * @note Arbitrary permutation vectors are supported with rank not greater than 4
60  *
61  * @param[in] src The src tensor info. Data types supported: All.
62  * @param[in] dst The dst tensor info. Data types supported: same as @p src.
63  * @param[in] perm Permutation vector
64  *
65  * @return a status
66  */
67  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PermutationVector &perm);
68 
69  // Inherited methods overridden:
70  void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
71 
72 private:
73  PermutationVector _perm{};
74 };
75 } // namespace kernels
76 } // namespace opencl
77 } // namespace arm_compute
78 #endif /*ARM_COMPUTE_CL_PERMUTE_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
OpenCL kernel to perform tensor permutation.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
ClPermuteKernel()=default
Default constructor.
CLCompileContext class.
void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm)
Set the src and dst of the kernel.
Strides of an item in bytes.
Definition: Strides.h:37
void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PermutationVector &perm)
Static function to check if given info will lead to a valid configuration of ClPermuteKernel.
Tensor packing service.
Definition: ITensorPack.h:37
Describe a multidimensional execution window.
Definition: Window.h:39