Compute Library
 22.02
CLPermute.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_CLPERMUTE_H
25 #define ARM_COMPUTE_CLPERMUTE_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class CLCompileContext;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to execute an @ref opencl::kernels::ClPermuteKernel. */
39 class CLPermute : public IFunction
40 {
41 public:
42  /** Constructor */
43  CLPermute();
44  /** Destructor */
45  ~CLPermute();
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  CLPermute(const CLPermute &) = delete;
48  /** Default move constructor */
49  CLPermute(CLPermute &&) = default;
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  CLPermute &operator=(const CLPermute &) = delete;
52  /** Default move assignment operator */
53  CLPermute &operator=(CLPermute &&) = default;
54  /** Set the input and output tensors.
55  *
56  * Valid data layouts:
57  * - NHWC
58  * - NCHW
59  *
60  * Valid data type configurations:
61  * |src |dst |
62  * |:--------------|:--------------|
63  * |All |All |
64  *
65  * @note Arbitrary permutation vectors are supported with rank not greater than 4
66  *
67  * @param[in] input The input tensor to permute. Data types supported: All.
68  * @param[in] output The output tensor. Data types supported: Same as @p input
69  * @param[in] perm Permutation vector
70  */
71  void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm);
72  /** Set the input and output tensors.
73  *
74  * @note Arbitrary permutation vectors are supported with rank not greater than 4
75  *
76  * @param[in] compile_context The compile context to be used.
77  * @param[in] input The input tensor to permute. Data types supported: All.
78  * @param[in] output The output tensor. Data types supported: Same as @p input
79  * @param[in] perm Permutation vector
80  */
81  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const PermutationVector &perm);
82  /** Static function to check if given info will lead to a valid configuration of @ref CLPermute.
83  *
84  * @note Arbitrary permutation vectors are supported with rank not greater than 4
85  *
86  * @param[in] input First tensor input info. Data types supported: All.
87  * @param[in] output Output tensor info. Data types supported: same as @p input.
88  * @param[in] perm Permutation vector
89  *
90  * @return a status
91  */
92  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm);
93 
94  // Inherited methods overridden:
95  void run() override;
96 
97 private:
98  struct Impl;
99  std::unique_ptr<Impl> _impl;
100 };
101 } // namespace arm_compute
102 #endif /*ARM_COMPUTE_CLPERMUTE_H */
Base class for all functions.
Definition: IFunction.h:30
CLPermute & operator=(const CLPermute &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~CLPermute()
Destructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2021 Arm Limited.
void run() override
Run the kernels contained in the function.
Definition: CLPermute.cpp:73
Basic function to execute an opencl::kernels::ClPermuteKernel.
Definition: CLPermute.h:39
CLPermute()
Constructor.
Definition: CLPermute.cpp:44
CLCompileContext class.
Strides of an item in bytes.
Definition: Strides.h:37
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm)
Set the input and output tensors.
Definition: CLPermute.cpp:51
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm)
Static function to check if given info will lead to a valid configuration of CLPermute.
Definition: CLPermute.cpp:68