blob: 4651b30e8e0264cc04ff00d5810edcbacdc0ce5c [file] [log] [blame]
Georgios Pinitas284cfe22018-02-13 12:15:13 +00001/*
Michalis Spyrouf4643372019-11-29 16:17:13 +00002 * Copyright (c) 2018-2019 ARM Limited.
Georgios Pinitas284cfe22018-02-13 12:15:13 +00003 *
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 */
Michalis Spyrouf4643372019-11-29 16:17:13 +000024#ifndef ARM_COMPUTE_NEPERMUTE_H
25#define ARM_COMPUTE_NEPERMUTE_H
Georgios Pinitas284cfe22018-02-13 12:15:13 +000026
Michalis Spyrou95abfdd2018-11-28 14:59:47 +000027#include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
Georgios Pinitas284cfe22018-02-13 12:15:13 +000028
29#include "arm_compute/core/Types.h"
30
31namespace arm_compute
32{
Georgios Pinitas33843562019-12-10 13:33:18 +000033// Forward declarations
Georgios Pinitas284cfe22018-02-13 12:15:13 +000034class ITensor;
35
36/** Basic function to run @ref NEPermuteKernel */
Michalis Spyrou95abfdd2018-11-28 14:59:47 +000037class NEPermute : public INESimpleFunctionNoBorder
Georgios Pinitas284cfe22018-02-13 12:15:13 +000038{
39public:
40 /** Configure the permute NEON kernel
41 *
Georgios Pinitascc4815f2019-12-04 18:02:41 +000042 * @note Arbitrary permutation vectors are supported with rank not greater than 4
Georgios Pinitas284cfe22018-02-13 12:15:13 +000043 *
Georgios Pinitas33843562019-12-10 13:33:18 +000044 * @param[in] input The input tensor to permute. Data types supported: All
Georgios Pinitas284cfe22018-02-13 12:15:13 +000045 * @param[out] output The output tensor. Data types supported: Same as @p input
46 * @param[in] perm Permutation vector
47 */
48 void configure(const ITensor *input, ITensor *output, const PermutationVector &perm);
49 /** Static function to check if given info will lead to a valid configuration of @ref NEPermute
50 *
Georgios Pinitascc4815f2019-12-04 18:02:41 +000051 * @note Arbitrary permutation vectors are supported with rank not greater than 4
Georgios Pinitas284cfe22018-02-13 12:15:13 +000052 *
Georgios Pinitas33843562019-12-10 13:33:18 +000053 * @param[in] input The input tensor to permute. Data types supported: All
Georgios Pinitas284cfe22018-02-13 12:15:13 +000054 * @param[in] output The output tensor. Data types supported: Same as @p input
55 * @param[in] perm Permutation vector
56 *
57 * @return a status
58 */
59 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm);
60};
Michalis Spyrou95abfdd2018-11-28 14:59:47 +000061} // namespace arm_compute
Michalis Spyrouf4643372019-11-29 16:17:13 +000062#endif /* ARM_COMPUTE_NEPERMUTE_H */