xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEPriorBoxLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NEPRIORBOXLAYER_H
25 #define ARM_COMPUTE_NEPRIORBOXLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 class ITensorInfo;
34 
35 /** Basic function to run @ref NEPriorBoxLayerKernel. */
36 class NEPriorBoxLayer : public INESimpleFunctionNoBorder
37 {
38 public:
39     /** Set the input and output tensors.
40      *
41      * Valid data layouts:
42      * - NHWC
43      * - NCHW
44      *
45      * Valid data type configurations:
46      * |src0     |src1     |dst      |
47      * |:--------|:--------|:--------|
48      * |F32      |F32      |F32      |
49      *
50      * @param[in]  input1 First source tensor. Data types supported: F32. Data layouts supported: NCHW/NHWC.
51      * @param[in]  input2 Second source tensor. Data types and layouts supported: same as @p input1
52      * @param[out] output Destination tensor. Output dimensions are [W * H * num_priors * 4, 2]. Data type supported: same as @p input
53      * @param[in]  info   Prior box layer info.
54      */
55     void configure(const ITensor *input1, const ITensor *input2, ITensor *output, const PriorBoxLayerInfo &info);
56     /** Static function to check if given info will lead to a valid configuration of @ref NEPriorBoxLayer
57      *
58      * @param[in] input1 First source tensor info. Data types supported: F32. Data layouts supported: NCHW/NHWC.
59      * @param[in] input2 Second source tensor info. Data types and layouts supported: same as @p input1
60      * @param[in] output Destination tensor info. Output dimensions are [W * H * num_priors * 4, 2]. Data type supported: same as @p input
61      * @param[in] info   Prior box layer info.
62      *
63      * @return a status
64      */
65     static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const PriorBoxLayerInfo &info);
66 };
67 } // namespace arm_compute
68 #endif /* ARM_COMPUTE_NEPRIORBOXLAYER_H */
69