xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEUnstack.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_NEUNSTACK_H
25 #define ARM_COMPUTE_NEUNSTACK_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 
30 #include "arm_compute/runtime/NEON/functions/NEStridedSlice.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 // Forward declarations
37 class ITensor;
38 
39 /** Basic function to unpack a rank-R tensor into rank-(R-1) tensors. This function calls the following functions:
40  *
41  * -# @ref NEStridedSlice
42  */
43 class NEUnstack : public IFunction
44 {
45 public:
46     /** Default constructor */
47     NEUnstack();
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEUnstack(const NEUnstack &) = delete;
50     /** Prevent instances of this class from being copied (As this class contains pointers) */
51     NEUnstack &operator=(const NEUnstack &) = delete;
52     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
53     NEUnstack(NEUnstack &&) = delete;
54     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
55     NEUnstack &operator=(NEUnstack &&) = delete;
56     /** Default destructor */
57     ~NEUnstack() = default;
58     /** Set the input, output and unstacking axis.
59      *
60      * Valid data layouts:
61      * - All
62      *
63      * Valid data type configurations:
64      * |src            |dst            |
65      * |:--------------|:--------------|
66      * |All            |All            |
67      *
68      * @param[in]     input         A tensor to be unstacked. Data type supported: All.
69      * @param[in,out] output_vector A vector of tensors. Data types supported: same as @p input.
70      *                              Note: The number of elements of the vector will be used as the number of slices to be taken from the axis.
71      * @param[in]     axis          The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around.
72      *
73      */
74     void configure(const ITensor *input, const std::vector<ITensor *> &output_vector, int axis);
75     /** Static function to check if given info will lead to a valid configuration of @ref NEUnstack
76      *
77      * @param[in] input         Input tensor info. Data type supported: All.
78      * @param[in] output_vector Vector of output tensors' info. Data types supported: same as @p input.
79      * @param[in] axis          The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around.
80      *
81      * @return a status
82      */
83     static Status validate(const ITensorInfo *input, const std::vector<ITensorInfo *> &output_vector, int axis);
84 
85     // Inherited methods overridden:
86     void run() override;
87 
88 private:
89     unsigned int                _num_slices;
90     std::vector<NEStridedSlice> _strided_slice_vector;
91 };
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_NEUNSTACK_H */
94