xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEPooling3dLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 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_NEPOOLING3DLAYER_H
25 #define ARM_COMPUTE_NEPOOLING3DLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 // Forward declarations
35 class ITensor;
36 class ITensorInfo;
37 class IMemoryManager;
38 /** Basic function to simulate a pooling 3d layer with the specified pooling operation. This function calls the following kernels:
39  *
40  * -# @ref cpu::CpuPool3d
41  */
42 class NEPooling3dLayer : public IFunction
43 {
44 public:
45     /** Constructor */
46     NEPooling3dLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NEPooling3dLayer(const NEPooling3dLayer &) = delete;
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEPooling3dLayer &operator=(const NEPooling3dLayer &) = delete;
51     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
52     NEPooling3dLayer(NEPooling3dLayer &&) = delete;
53     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
54     NEPooling3dLayer &operator=(NEPooling3dLayer &&) = delete;
55     /** Default destructor */
56     ~NEPooling3dLayer();
57     /** Set the input and output tensors.
58      *
59      * Valid data layouts:
60      * - NDHWC
61      *
62      * Valid data type configurations:
63      * |src            |dst            |
64      * |:--------------|:--------------|
65      * |F16            |F16            |
66      * |F32            |F32            |
67      * |QASYMM8        |QASYMM8        |
68      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
69      *
70      * @note Source tensor is padded with -inf for MAX pooling and 0 otherwise
71      *
72      * @param[in]  input     Source tensor. Data types supported: F16/F32/QASYMM8/QASYMM8_SIGNED.
73      * @param[out] output    Destination tensor.
74      * @param[in]  pool_info Contains pooling operation information described in @ref Pooling3dLayerInfo.
75      */
76     void configure(const ITensor *input, ITensor *output, const Pooling3dLayerInfo &pool_info);
77     /** Static function to check if given info will lead to a valid configuration of @ref NEPooling3dLayer
78      *
79      *
80      * @param[in] input     Source tensor info. Data types supported: F16/F32/QASYMM8/QASYMM8_SIGNED.
81      * @param[in] output    Destination tensor info.
82      * @param[in] pool_info Contains pooling operation information described in @ref Pooling3dLayerInfo.
83      *
84      * @return a status
85      */
86     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Pooling3dLayerInfo &pool_info);
87 
88     // Inherited methods overridden:
89     void run() override;
90 
91 private:
92     struct Impl;
93     std::unique_ptr<Impl> _impl;
94 };
95 }
96 #endif /* ARM_COMPUTE_NEPOOLING3DLAYER_H */
97