xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuPool3d.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_CPU_POOL3D_H
25 #define ARM_COMPUTE_CPU_POOL3D_H
26 
27 #include "arm_compute/core/experimental/Types.h"
28 #include "src/core/common/Macros.h"
29 #include "src/cpu/ICpuOperator.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 namespace cpu
36 {
37 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following kernels:
38  *
39  * -# @ref kernels::CpuPool3dKernel
40  */
41 class CpuPool3d : public ICpuOperator
42 {
43 public:
44     CpuPool3d();
45     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuPool3d);
46     ~CpuPool3d();
47     /** Set the src and dst tensors.
48      *
49      *
50      * @param[in]  src       Source tensor info. Data types supported: F16/F32/QASYMM8/QASYMM8_SIGNED.
51      * @param[out] dst       Destination tensor info. Data types supported: same as @p src.
52      * @param[in]  pool_info Contains pooling operation information described in @ref Pooling3dLayerInfo.
53      */
54     void configure(const ITensorInfo *src, ITensorInfo *dst, const Pooling3dLayerInfo &pool_info);
55     /** Static function to check if given info will lead to a valid configuration
56      *
57      * Similar to CpuPool3d::configure()
58      *
59      * @return a status
60      */
61     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const Pooling3dLayerInfo &pool_info);
62 
63     // Inherited methods overridden:
64     void run(ITensorPack &tensors) override;
65     experimental::MemoryRequirements workspace() const override;
66 
67 private:
68     experimental::MemoryRequirements _aux_mem{};
69 };
70 } // namespace cpu
71 } // namespace arm_compute
72 #endif /* ARM_COMPUTE_CPU_POOL3D_H */
73