Compute Library
 21.02
NETranspose.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_NETRANSPOSE_H
25 #define ARM_COMPUTE_NETRANSPOSE_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 class ITensorInfo;
34 
35 /** Basic function to transpose a matrix on Neon. This function calls the following Neon kernel:
36  *
37  * -# @ref NETransposeKernel
38  *
39  */
41 {
42 public:
43  /** Initialise the kernel's inputs and output
44  *
45  * @param[in] input Input tensor. Data types supported: All
46  * @param[out] output Output tensor. Data type supported: Same as @p input
47  */
48  void configure(const ITensor *input, ITensor *output);
49  /** Static function to check if given info will lead to a valid configuration of @ref NETranspose
50  *
51  * @param[in] input The input tensor. Data types supported: All
52  * @param[in] output The output tensor. Data types supported: Same as @p input
53  *
54  * @return a status
55  */
56  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
57 };
58 } // namespace arm_compute
59 
60 #endif /* ARM_COMPUTE_NETRANSPOSE_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
void configure(const ITensor *input, ITensor *output)
Initialise the kernel's inputs and output.
Definition: NETranspose.cpp:32
Basic interface for functions which have a single Neon kernel and no border.
Basic function to transpose a matrix on Neon.
Definition: NETranspose.h:40
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of NETranspose.
Definition: NETranspose.cpp:39