xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NEChannelShuffleLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_NECHANNELSHUFFLELAYERKERNEL_H
25 #define ARM_COMPUTE_NECHANNELSHUFFLELAYERKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 
29 namespace arm_compute
30 {
31 // Forward declarations
32 class ITensor;
33 
34 /** Interface for the channel shuffle kernel */
35 class NEChannelShuffleLayerKernel : public INEKernel
36 {
37 public:
name()38     const char *name() const override
39     {
40         return "NEChannelShuffleLayerKernel";
41     }
42     /** Default constructor */
43     NEChannelShuffleLayerKernel();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NEChannelShuffleLayerKernel(const NEChannelShuffleLayerKernel &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEChannelShuffleLayerKernel &operator=(const NEChannelShuffleLayerKernel &) = delete;
48     /** Allow instances of this class to be moved */
49     NEChannelShuffleLayerKernel(NEChannelShuffleLayerKernel &&) = default;
50     /** Allow instances of this class to be moved */
51     NEChannelShuffleLayerKernel &operator=(NEChannelShuffleLayerKernel &&) = default;
52     /** Default destructor */
53     ~NEChannelShuffleLayerKernel() = default;
54     /** Configure function's inputs and outputs.
55      *
56      * @param[in]  input      Input tensor. Data types supported: All
57      * @param[out] output     Output tensor. Data type supported: Same as @p input
58      * @param[in]  num_groups Number of groups. Must be greater than 1 and the number of channels of the tensors must be a multiple of the number of groups.
59      */
60     void configure(const ITensor *input, ITensor *output, unsigned int num_groups);
61     /** Static function to check if given info will lead to a valid configuration of @ref NEChannelShuffleLayerKernel
62      *
63      * @param[in]  input      Input tensor. Data types supported: All
64      * @param[out] output     Output tensor. Data type supported: Same as @p input
65      * @param[in]  num_groups Number of groups. Must be greater than 1 and the number of channels of the tensors must be a multiple of the number of groups.
66      *
67      * @return a status
68      */
69     static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int num_groups);
70 
71     // Inherited methods overridden:
72     void run(const Window &window, const ThreadInfo &info) override;
73 
74 private:
75     const ITensor *_input;
76     ITensor       *_output;
77     unsigned int   _num_groups;
78 };
79 } // namespace arm_compute
80 #endif /* ARM_COMPUTE_NECHANNELSHUFFLELAYERKERNEL_H */
81