• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2019-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_CLCOMPUTEALLANCHORS_H
25 #define ARM_COMPUTE_CLCOMPUTEALLANCHORS_H
26 
27 #include "arm_compute/core/Error.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 class ComputeAnchorsInfo;
36 
37 /** Basic function to run @ref CLComputeAllAnchorsKernel.
38  *
39  * This function calls the following OpenCL kernels:
40  * -# @ref CLComputeAllAnchorsKernel
41  */
42 class CLComputeAllAnchors : public ICLSimpleFunction
43 {
44 public:
45     /** Set the input and output tensors.
46      *
47      * @param[in]  anchors     Source tensor. Original set of anchors of size (4, A) where A is the number of anchors. Data types supported: F16/F32
48      * @param[out] all_anchors Destination tensor. Destination anchors of size (4, H*W*A) where H and W are the height and width of the feature map and A is the number of anchors. Data types supported: Same as @p input
49      * @param[in]  info        Contains Compute Anchors operation information described in @ref ComputeAnchorsInfo
50      *
51      */
52     void configure(const ICLTensor *anchors, ICLTensor *all_anchors, const ComputeAnchorsInfo &info);
53     /** Set the input and output tensors.
54      *
55      * @param[in]  compile_context The compile context to be used.
56      * @param[in]  anchors         Source tensor. Original set of anchors of size (4, A) where A is the number of anchors. Data types supported: F16/F32
57      * @param[out] all_anchors     Destination tensor. Destination anchors of size (4, H*W*A) where H and W are the height and width of the feature map and A is the number of anchors. Data types supported: Same as @p input
58      * @param[in]  info            Contains Compute Anchors operation information described in @ref ComputeAnchorsInfo
59      *
60      */
61     void configure(const CLCompileContext &compile_context, const ICLTensor *anchors, ICLTensor *all_anchors, const ComputeAnchorsInfo &info);
62 
63     /** Static function to check if given info will lead to a valid configuration of @ref CLComputeAllAnchorsKernel
64      *
65      * @param[in] anchors     Source tensor info. Original set of anchors of size (4, A) where A is the number of anchors. Data types supported: F16/F32
66      * @param[in] all_anchors Destination tensor info. Destination anchors of size (4, H*W*A) where H and W are the height and width of the feature map and A is the number of anchors. Data types supported: Same as @p input
67      * @param[in] info        Contains Compute Anchors operation information described in @ref ComputeAnchorsInfo
68      *
69      * @return a Status
70      */
71     static Status validate(const ITensorInfo *anchors, const ITensorInfo *all_anchors, const ComputeAnchorsInfo &info);
72 };
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_CLCOMPUTEALLANCOHORS_H */
75