Compute Library
 21.02
NEPadLayer.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 #ifndef ARM_COMPUTE_NEPADLAYER_H
25 #define ARM_COMPUTE_NEPADLAYER_H
26 
32 
33 #include "arm_compute/core/Types.h"
35 #include <memory>
36 
37 namespace arm_compute
38 {
39 class NEPadLayerKernel;
40 
41 /** Basic function to pad a tensor. This function calls the following Neon functions/kernels:
42  *
43  * - For padding mode = PaddingMode::CONSTANT:
44  * -# @ref NEPadLayerKernel
45  * - Otherwise:
46  * -# @ref NECopy
47  * -# @ref NEStridedSlice
48  * -# @ref NEConcatenateLayer
49  *
50  */
51 class NEPadLayer : public IFunction
52 {
53 public:
54  /** Default Constructor */
55  NEPadLayer();
56  /** Prevent instances of this class from being copied (As this class contains pointers) */
57  NEPadLayer(const NEPadLayer &) = delete;
58  /** Prevent instances of this class from being copied (As this class contains pointers) */
59  NEPadLayer &operator=(const NEPadLayer &) = delete;
60  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
61  NEPadLayer(NEPadLayer &&) = delete;
62  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
63  NEPadLayer &operator=(NEPadLayer &&) = delete;
64  /** Default destructor */
65  ~NEPadLayer();
66  /** Initialize the function
67  *
68  * @param[in] input Source tensor. Data types supported: All.
69  * @param[out] output Output tensor. Data type supported: same as @p input
70  * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i]
71  * specifies the front and the end padding in the i-th dimension.
72  * @param[in] constant_value (Optional) Constant value to be used for the padding
73  * @param[in] mode (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT,
74  * or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT).
75  */
76  void configure(ITensor *input, ITensor *output, const PaddingList &padding, const PixelValue constant_value = PixelValue(), const PaddingMode mode = PaddingMode::CONSTANT);
77  /** Static function to check if given info will lead to a valid configuration of @ref NEPadLayer.
78  *
79  * @param[in] input Source tensor info. Data types supported: All.
80  * @param[in] output Output tensor info. Data type supported: same as @p input
81  * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i]
82  * specifies the front and the end padding in the i-th dimension.
83  * @param[in] constant_value (Optional) Constant value to be used for the padding
84  * @param[in] mode (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT,
85  * or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT).
86  *
87  * @return a status
88  */
89  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PaddingList &padding, const PixelValue constant_value = PixelValue(), const PaddingMode mode = PaddingMode::CONSTANT);
90 
91  // Inherited methods overridden:
92  void run() override;
93 
94 private:
95  /** Configure kernels for when constant padding is used.
96  *
97  * @param[in] input Source tensor. Data types supported: All.
98  * @param[out] output Output tensor. Data type supported: same as @p input
99  * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i]
100  * specifies the front and the end padding in the i-th dimension.
101  * @param[in] constant_value Constant value to be used for the padding
102  */
103  void configure_constant_mode(ITensor *input, ITensor *output, const PaddingList &padding, const PixelValue constant_value);
104  /** Configure functions for when reflect or symmetric padding is used.
105  *
106  * @param[in] input Source tensor. Data types supported: All.
107  * @param[out] output Output tensor. Data type supported: same as @p input
108  */
109  void configure_reflect_symmetric_mode(ITensor *input, ITensor *output);
110 
111 private:
112  NECopy _copy_function;
113  std::unique_ptr<NEPadLayerKernel> _pad_kernel;
114  PaddingMode _mode;
115  PaddingList _padding;
116  uint32_t _num_dimensions;
117  std::vector<NEStridedSlice> _slice_functions;
118  std::vector<NEConcatenateLayer> _concat_functions;
119  std::vector<Tensor> _slice_results;
120  std::vector<Tensor> _concat_results;
121 };
122 } // namespace arm_compute
123 #endif /*ARM_COMPUTE_NEPADLAYER_H */
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
Base class for all functions.
Definition: IFunction.h:30
std::vector< PaddingInfo > PaddingList
List of padding information.
Definition: Types.h:481
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.
PaddingMode
Padding mode to use for PadLayer.
Definition: Types.h:169
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PaddingList &padding, const PixelValue constant_value=PixelValue(), const PaddingMode mode=PaddingMode::CONSTANT)
Static function to check if given info will lead to a valid configuration of NEPadLayer.
Definition: NEPadLayer.cpp:206
~NEPadLayer()
Default destructor.
NEPadLayer()
Default Constructor.
Definition: NEPadLayer.cpp:53
void run() override
Run the kernels contained in the function.
Definition: NEPadLayer.cpp:250
void configure(ITensor *input, ITensor *output, const PaddingList &padding, const PixelValue constant_value=PixelValue(), const PaddingMode mode=PaddingMode::CONSTANT)
Initialize the function.
Definition: NEPadLayer.cpp:167
Basic function to pad a tensor.
Definition: NEPadLayer.h:51
NEPadLayer & operator=(const NEPadLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to run cpu::kernels::CpuCopyKernel.
Definition: NECopy.h:39