xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NETranspose.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NETRANSPOSE_H
25 #define ARM_COMPUTE_NETRANSPOSE_H
26 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class ITensor;
37 class ITensorInfo;
38 
39 /** Basic function to run @ref cpu::kernels::CpuTransposeKernel */
40 class NETranspose : public IFunction
41 {
42 public:
43     /** Default Constructor */
44     NETranspose();
45     /** Default Destructor */
46     ~NETranspose();
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NETranspose(const NETranspose &) = delete;
49     /** Default move constructor */
50     NETranspose(NETranspose &&) = default;
51     /** Prevent instances of this class from being copied (As this class contains pointers) */
52     NETranspose &operator=(const NETranspose &) = delete;
53     /** Default move assignment operator */
54     NETranspose &operator=(NETranspose &&) = default;
55     /** Initialise the kernel's inputs and output
56      *
57      * Valid data layouts:
58      * - All
59      *
60      * Valid data type configurations:
61      * |src    |dst    |
62      * |:------|:------|
63      * |All    |All    |
64      *
65      * @param[in]  input  Input tensor. Data types supported: All
66      * @param[out] output Output tensor. Data type supported: Same as @p input
67      */
68     void configure(const ITensor *input, ITensor *output);
69     /** Static function to check if given info will lead to a valid configuration of @ref NETranspose
70      *
71      * @param[in] input  The input tensor. Data types supported: All
72      * @param[in] output The output tensor. Data types supported: Same as @p input
73      *
74      * @return a status
75      */
76     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
77 
78     // Inherited methods overridden
79     void run() override;
80 
81 private:
82     struct Impl;
83     std::unique_ptr<Impl> _impl;
84 };
85 } // namespace arm_compute
86 #endif /* ARM_COMPUTE_NETRANSPOSE_H */