• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-2020 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"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to transpose a matrix on OpenCL. This function calls the following OpenCL kernel:
37  *
38  *  -# @ref CLTransposeKernel
39  *
40  */
41 class CLTranspose : public ICLSimpleFunction
42 {
43 public:
44     /** Initialise the kernel's inputs and output
45      *
46      * @param[in]  input  Input tensor. Data types supported: All.
47      * @param[out] output Output tensor. Data type supported: Same as @p input
48      */
49     void configure(const ICLTensor *input, ICLTensor *output);
50     /** Initialise the kernel's inputs and output
51      *
52      * @param[in]  compile_context The compile context to be used.
53      * @param[in]  input           Input tensor. Data types supported: All.
54      * @param[out] output          Output tensor. Data type supported: Same as @p input
55      */
56     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
57     /** Static function to check if given info will lead to a valid configuration of @ref CLTranspose
58      *
59      * @param[in] input  The input tensor. Data types supported: All.
60      * @param[in] output The output tensor. Data types supported: Same as @p input
61      *
62      * @return a status
63      */
64     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
65 };
66 }
67 
68 #endif /* ARM_COMPUTE_CLTRANSPOSE_H */
69