Compute Library
 21.02
NEMaxUnpoolingLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-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_NEMAXUNPOOLINGLAYER_H
25 #define ARM_COMPUTE_NEMAXUNPOOLINGLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 class NEFill;
36 class NEMaxUnpoolingLayerKernel;
37 
38 /** Function to perform MaxUnpooling. This function calls the following Neon kernels:
39  *
40  * -# @ref NEFill
41  * -# @ref NEMaxUnpoolingLayerKernel
42  */
44 {
45 public:
46  /** Constructor */
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  NEMaxUnpoolingLayer(const NEMaxUnpoolingLayer &) = delete;
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
54  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
56  /** Default destructor */
58  /** Set the input and output tensors.
59  *
60  * @note Only supported pool size 2
61  *
62  * @param[in, out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
63  * @param[out] output Destination tensor. Data types supported: Same as @p input.
64  * @param[out] indices The indices of the maximal values. Data type supported: U32.
65  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
66  */
67  void configure(ITensor *input, ITensor *indices, ITensor *output, const PoolingLayerInfo &pool_info);
68  /** Static function to check if given info will lead to a valid configuration of @ref NEMaxUnpoolingLayer
69  *
70  * @note Only supported pool size 2
71  *
72  * @param[in] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
73  * @param[in] indices The indices of the maximal values. Data type supported: U32.
74  * @param[in] output Destination tensor. Data types supported: Same as @p input.
75  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
76  *
77  * @return a status
78  */
79  static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, const PoolingLayerInfo &pool_info);
80 
81  // Inherited methods overridden:
82  void run() override;
83 
84 private:
85  std::unique_ptr<NEFill> _fill_func;
86  std::unique_ptr<NEMaxUnpoolingLayerKernel> _unpooling_layer_kernel;
87 };
88 }
89 #endif /* ARM_COMPUTE_NEMAXUNPOOLINGLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, const PoolingLayerInfo &pool_info)
Static function to check if given info will lead to a valid configuration of NEMaxUnpoolingLayer.
void configure(ITensor *input, ITensor *indices, ITensor *output, const PoolingLayerInfo &pool_info)
Set the input and output tensors.
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.
Pooling Layer Information struct.
Definition: Types.h:1214
Function to perform MaxUnpooling.
void run() override
Run the kernels contained in the function.
~NEMaxUnpoolingLayer()
Default destructor.
NEMaxUnpoolingLayer & operator=(const NEMaxUnpoolingLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...