Compute Library
 22.08
NEStackLayerKernel.h
Go to the documentation of this file.
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 
25 #ifndef ARM_COMPUTE_NESTACKLAYERKERNEL_H
26 #define ARM_COMPUTE_NESTACKLAYERKERNEL_H
27 
28 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 
35 /** Basic kernel to stack a rank-R tensor into one with rank-(R+1) along the axis dimension. */
37 {
38 public:
39  const char *name() const override
40  {
41  return "NEStackLayerKernel";
42  }
43  /** Default constructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  NEStackLayerKernel(const NEStackLayerKernel &) = delete;
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  /** Allow instances of this class to be moved */
51  /** Allow instances of this class to be moved */
53  /** Default destructor */
54  ~NEStackLayerKernel() = default;
55  /** Initialise the kernel's inputs and output
56  *
57  * @note Supported input tensor rank: up to 4
58  *
59  * @param[in] input Input tensor. Data types supported: All
60  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
61  * @param[in] idx_input Index of the input tensor in the list of tensors to stack.
62  * All tensors in the list must have the same shape
63  * @param[in] num_tensors Number of tensors to stack
64  * @param[out] output Output tensor. Data types supported: Same as @p input.
65  *
66  */
67  void configure(const ITensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ITensor *output);
68  /** Static function to check if given info will lead to a valid configuration of @ref NEStackLayerKernel
69  *
70  * @note Supported input tensor rank: up to 4
71  *
72  * @param[in] input Input tensor info. Data types supported: All
73  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
74  * @param[in] idx_input Index of the input tensor in the list of tensors to stack
75  * All tensors in the list must have the same shape
76  * @param[in] num_tensors Number of tensors to stack
77  * @param[in] output Output tensor info. Data types supported: Same as @p input.
78  *
79  * @return a status
80  */
81  static Status validate(const ITensorInfo *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, const ITensorInfo *output);
82 
83  // Inherited methods overridden
84  void run(const Window &window, const ThreadInfo &info) override;
85 
86 private:
87  const ITensor *_input;
88  ITensor *_output;
89  unsigned int _axis;
90  unsigned int _idx_input;
91 };
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_NESTACKLAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
NEStackLayerKernel()
Default constructor.
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
Basic kernel to stack a rank-R tensor into one with rank-(R+1) along the axis dimension.
static Status validate(const ITensorInfo *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of NEStackLayerKernel.
const char * name() const override
Name of the kernel.
NEStackLayerKernel & operator=(const NEStackLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~NEStackLayerKernel()=default
Default destructor.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:179
Describe a multidimensional execution window.
Definition: Window.h:39
void configure(const ITensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ITensor *output)
Initialise the kernel's inputs and output.