Compute Library
 21.08
CLTranspose.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CLTRANSPOSE_H
25 #define ARM_COMPUTE_CLTRANSPOSE_H
26 
27 #include "arm_compute/core/Error.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::ClTransposeKernel. */
39 class CLTranspose : public IFunction
40 {
41 public:
42  /** Constructor */
43  CLTranspose();
44  /** Destructor */
45  ~CLTranspose();
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  CLTranspose(const CLTranspose &) = delete;
48  /** Default move constructor */
49  CLTranspose(CLTranspose &&) = default;
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  CLTranspose &operator=(const CLTranspose &) = delete;
52  /** Default move assignment operator */
53  CLTranspose &operator=(CLTranspose &&) = default;
54  /** Initialise the kernel's inputs and output
55  *
56  * Valid data layouts:
57  * - All
58  *
59  * Valid data type configurations:
60  * |src |dst |
61  * |:--------------|:--------------|
62  * |All |All |
63  *
64  * @param[in] input Input tensor. Data types supported: All.
65  * @param[out] output Output tensor. Data type supported: Same as @p input
66  */
67  void configure(const ICLTensor *input, ICLTensor *output);
68  /** Initialise the kernel's inputs and output
69  *
70  * @param[in] compile_context The compile context to be used.
71  * @param[in] input Input tensor. Data types supported: All.
72  * @param[out] output Output tensor. Data type supported: Same as @p input
73  */
74  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
75  /** Static function to check if given info will lead to a valid configuration of @ref CLTranspose
76  *
77  * @param[in] input The input tensor. Data types supported: All.
78  * @param[in] output The output tensor. Data types supported: Same as @p input
79  *
80  * @return a status
81  */
82  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
83 
84  // Inherited methods overridden:
85  void run() override;
86 
87 private:
88  struct Impl;
89  std::unique_ptr<Impl> _impl;
90 };
91 }
92 
93 #endif /* ARM_COMPUTE_CLTRANSPOSE_H */
Base class for all functions.
Definition: IFunction.h:30
~CLTranspose()
Destructor.
CLTranspose()
Constructor.
Definition: CLTranspose.cpp:41
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: CLTranspose.cpp:66
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLTranspose.
Definition: CLTranspose.cpp:61
CLTranspose & operator=(const CLTranspose &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to execute an opencl::kernels::ClTransposeKernel.
Definition: CLTranspose.h:39
void configure(const ICLTensor *input, ICLTensor *output)
Initialise the kernel&#39;s inputs and output.
Definition: CLTranspose.cpp:47