xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLPriorBoxLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1  /*
2   * Copyright (c) 2018-2020 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_CLPRIORBOXLAYERKERNEL_H
25  #define ARM_COMPUTE_CLPRIORBOXLAYERKERNEL_H
26  
27  #include "src/core/CL/ICLKernel.h"
28  
29  namespace arm_compute
30  {
31  class ICLTensor;
32  
33  /** Interface for the PriorBox layer kernel. */
34  class CLPriorBoxLayerKernel : public ICLKernel
35  {
36  public:
37      /** Constructor */
38      CLPriorBoxLayerKernel();
39      /** Prevent instances of this class from being copied (As this class contains pointers) */
40      CLPriorBoxLayerKernel(const CLPriorBoxLayerKernel &) = delete;
41      /** Prevent instances of this class from being copied (As this class contains pointers) */
42      CLPriorBoxLayerKernel &operator=(const CLPriorBoxLayerKernel &) = delete;
43      /** Default Move Constructor. */
44      CLPriorBoxLayerKernel(CLPriorBoxLayerKernel &&) = default;
45      /** Default move assignment operator */
46      CLPriorBoxLayerKernel &operator=(CLPriorBoxLayerKernel &&) = default;
47      /** Default destructor */
48      ~CLPriorBoxLayerKernel() = default;
49  
50      /** Set the input and output tensors.
51       *
52       * @param[in]  input1        First source tensor. Data types supported: F32. Data layouts supported: NCHW/NHWC.
53       * @param[in]  input2        Second source tensor. Data types and layouts supported: same as @p input1
54       * @param[out] output        Destination tensor. Output dimensions are [W * H * num_priors * 4, 2]. Data types and layouts supported: same as @p input1
55       * @param[in]  info          Prior box layer info.
56       * @param[in]  min           Minimum prior box values
57       * @param[in]  max           Maximum prior box values
58       * @param[in]  aspect_ratios Aspect ratio values
59       */
60      void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const PriorBoxLayerInfo &info, cl::Buffer *min, cl::Buffer *max, cl::Buffer *aspect_ratios);
61      /** Set the input and output tensors.
62       *
63       * @param[in]  compile_context The compile context to be used.
64       * @param[in]  input1          First source tensor. Data types supported: F32. Data layouts supported: NCHW/NHWC.
65       * @param[in]  input2          Second source tensor. Data types and layouts supported: same as @p input1
66       * @param[out] output          Destination tensor. Output dimensions are [W * H * num_priors * 4, 2]. Data types and layouts supported: same as @p input1
67       * @param[in]  info            Prior box layer info.
68       * @param[in]  min             Minimum prior box values
69       * @param[in]  max             Maximum prior box values
70       * @param[in]  aspect_ratios   Aspect ratio values
71       */
72      void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const PriorBoxLayerInfo &info, cl::Buffer *min, cl::Buffer *max,
73                     cl::Buffer *aspect_ratios);
74      /** Static function to check if given info will lead to a valid configuration of @ref CLPriorBoxLayerKernel
75       *
76       * @param[in] input1 First source tensor info. Data types supported: F32. Data layouts supported: NCHW/NHWC.
77       * @param[in] input2 Second source tensor info. Data types and layouts supported: same as @p input1
78       * @param[in] output Destination tensor info. Output dimensions are [W * H * num_priors * 4, 2]. Data type supported: same as @p input1
79       * @param[in] info   Prior box layer info.
80       *
81       * @return a status
82       */
83      static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const PriorBoxLayerInfo &info);
84  
85      // Inherited methods overridden:
86      void run(const Window &window, cl::CommandQueue &queue) override;
87  
88  private:
89      const ICLTensor *_input1;
90      const ICLTensor *_input2;
91      ICLTensor        *_output;
92      PriorBoxLayerInfo _info;
93      int               _num_priors;
94      cl::Buffer       *_min;
95      cl::Buffer       *_max;
96      cl::Buffer       *_aspect_ratios;
97  };
98  } // namespace arm_compute
99  #endif /*ARM_COMPUTE_CLPRIORBOXLAYERKERNEL_H */
100