xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CPP/functions/CPPPermute.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_CPPPERMUTE_H
25 #define ARM_COMPUTE_CPPPERMUTE_H
26 
27 #include "arm_compute/runtime/CPP/ICPPSimpleFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 
35 /** Basic function to run @ref CPPPermuteKernel */
36 class CPPPermute : public ICPPSimpleFunction
37 {
38 public:
39     /** Configure the permute CPP kernel
40      *
41      * @param[in]  input  The input tensor to permute. Data types supported: All
42      * @param[out] output The output tensor. Data types supported: Same as @p input
43      * @param[in]  perm   Permutation vector
44      */
45     void configure(const ITensor *input, ITensor *output, const PermutationVector &perm);
46     /** Static function to check if given info will lead to a valid configuration of @ref CPPPermute
47      *
48      * @param[in] input  The input tensor to permute. Data types supported: All
49      * @param[in] output The output tensor. Data types supported: Same as @p input
50      * @param[in] perm   Permutation vector
51      *
52      * @return a status
53      */
54     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm);
55 };
56 }
57 #endif /* ARM_COMPUTE_CPPPERMUTE_H */
58