Compute Library
 22.08
CpuMaxUnpoolingLayerKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2022 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_CPUMAXUNPOOLINGLAYERKERNEL_H
25 #define ARM_COMPUTE_CPUMAXUNPOOLINGLAYERKERNEL_H
26 
27 #include "src/core/common/Macros.h"
28 #include "src/cpu/ICpuKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the pooling layer kernel */
37 class CpuMaxUnpoolingLayerKernel : public ICpuKernel<CpuMaxUnpoolingLayerKernel>
38 {
39 private:
41 
42 public:
43  /** Default constructor */
44  CpuMaxUnpoolingLayerKernel() = default;
46 
47  /** Configure kernel for a given list of arguments
48  *
49  * @note Dst shape must be equal to the shape of the original src to pool.
50  *
51  * @param[in] src Source tensor to permute. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
52  * @param[in] indices Tensor containing the offset to store the src elements in the dst tensor.
53  * @ref CpuMaxUnpooling with indices should precede this function in order to
54  * properly reconstruct the output tensor.
55  * The tensor shape of this tensor has to be equal to the src tensor shape. Data type supported: U32.
56  * @param[out] dst Destination tensor. Data types supported: Same as @p src
57  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
58  */
59  void configure(const ITensorInfo *src, const ITensorInfo *indices, ITensorInfo *dst, const PoolingLayerInfo &pool_info);
60  /** Static function to check if given info will lead to a valid configuration of @ref CpuMaxUnpoolingLayerKernel
61  *
62  * @param[in] src Source tensor to permute. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
63  * @param[in] indices Tensor info of the indices of the maximal values. Data type supported: U32.
64  * @param[out] dst Destination tensor. Data types supported: Same as @p src
65  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
66  *
67  * @return a status
68  */
69  static Status validate(const ITensorInfo *src, const ITensorInfo *indices, const ITensorInfo *dst, const PoolingLayerInfo &pool_info);
70 
71  // Inherited methods overridden:
72  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
73 
75  {
76  const char *name;
78  MaxUnpoolingUKernelPtr ukernel;
79  };
80 
81  static const std::vector<MaxUnpoolingKernel> &get_available_kernels();
82 
83  const char *name() const override;
84 
85 private:
86  MaxUnpoolingUKernelPtr _run_method{ nullptr };
87 };
88 
89 } // namespace kernels
90 } // namespace cpu
91 } // namespace arm_compute
92 #endif /*ARM_COMPUTE_CPUMAXUNPOOLINGLAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
static const std::vector< MaxUnpoolingKernel > & get_available_kernels()
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
decltype(strategy::transforms) typedef type
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2022 Arm Limited.
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
void configure(const ITensorInfo *src, const ITensorInfo *indices, ITensorInfo *dst, const PoolingLayerInfo &pool_info)
Configure kernel for a given list of arguments.
CpuMaxUnpoolingLayerKernel()=default
Default constructor.
Pooling Layer Information struct.
Definition: Types.h:1186
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuMaxUnpoolingLayerKernel)
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:179
static Status validate(const ITensorInfo *src, const ITensorInfo *indices, const ITensorInfo *dst, const PoolingLayerInfo &pool_info)
Static function to check if given info will lead to a valid configuration of CpuMaxUnpoolingLayerKern...
std::add_pointer< bool(const DataTypeISASelectorData &data)>::type DataTypeISASelectorPtr
Tensor packing service.
Definition: ITensorPack.h:39
Describe a multidimensional execution window.
Definition: Window.h:39