Compute Library
 21.08
CpuPermuteKernel.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_CPU_PERMUTE_KERNEL_H
25 #define ARM_COMPUTE_CPU_PERMUTE_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Kernel to perform tensor permutation given a permutation vector */
38 {
39 public:
40  CpuPermuteKernel() = default;
42  /** Configure kernel for a given list of arguments
43  *
44  * @note Arbitrary permutation vectors are supported with rank not greater than 4
45  *
46  * @param[in] src Srouce tensor to permute. Data types supported: All
47  * @param[out] dst Destination tensor. Data types supported: Same as @p src
48  * @param[in] perm Permutation vector
49  */
50  void configure(const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm);
51  /** Static function to check if given info will lead to a valid configuration
52  *
53  * Similar to @ref CpuPermuteKernel::configure()
54  *
55  * @return a status
56  */
57  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PermutationVector &perm);
58 
59  // Inherited methods overridden:
60  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
61  const char *name() const override;
62 
63 private:
64  PermutationVector _perm{};
65 };
66 } // namespace kernels
67 } // namespace cpu
68 } // namespace arm_compute
69 #endif /* ARM_COMPUTE_CPU_PERMUTE_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
void configure(const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm)
Configure kernel for a given list of arguments.
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
const char * name() const override
Name of the kernel.
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuPermuteKernel)
Kernel to perform tensor permutation given a permutation vector.
Strides of an item in bytes.
Definition: Strides.h:37
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:158
Tensor packing service.
Definition: ITensorPack.h:39
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
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.
Describe a multidimensional execution window.
Definition: Window.h:39