Compute Library
 21.02
NEUnstack.h
Go to the documentation of this file.
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_NEUNSTACK_H
25 #define ARM_COMPUTE_NEUNSTACK_H
26 
27 #include "arm_compute/core/Types.h"
29 
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  * @param[in] input A tensor to be unstacked. Data type supported: All.
61  * @param[in,out] output_vector A vector of tensors. Data types supported: same as @p input.
62  * Note: The number of elements of the vector will be used as the number of slices to be taken from the axis.
63  * @param[in] axis The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around.
64  *
65  */
66  void configure(const ITensor *input, const std::vector<ITensor *> &output_vector, int axis);
67  /** Static function to check if given info will lead to a valid configuration of @ref NEUnstack
68  *
69  * @param[in] input Input tensor info. Data type supported: All.
70  * @param[in] output_vector Vector of output tensors' info. Data types supported: same as @p input.
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  * @return a status
74  */
75  static Status validate(const ITensorInfo *input, const std::vector<ITensorInfo *> &output_vector, int axis);
76 
77  // Inherited methods overridden:
78  void run() override;
79 
80 private:
81  unsigned int _num_slices;
82  std::vector<NEStridedSlice> _strided_slice_vector;
83 };
84 } // namespace arm_compute
85 #endif /* ARM_COMPUTE_NEUNSTACK_H */
Base class for all functions.
Definition: IFunction.h:30
~NEUnstack()=default
Default destructor.
Store the tensor&#39;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, const std::vector< ITensor *> &output_vector, int axis)
Set the input, output and unstacking axis.
Definition: NEUnstack.cpp:62
Basic function to unpack a rank-R tensor into rank-(R-1) tensors.
Definition: NEUnstack.h:43
void run() override
Run the kernels contained in the function.
Definition: NEUnstack.cpp:112
NEUnstack & operator=(const NEUnstack &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
static Status validate(const ITensorInfo *input, const std::vector< ITensorInfo *> &output_vector, int axis)
Static function to check if given info will lead to a valid configuration of NEUnstack.
Definition: NEUnstack.cpp:90
NEUnstack()
Default constructor.
Definition: NEUnstack.cpp:56