xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLComparisonKernel.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_CLCOMPARISONKERNEL_H
25 #define ARM_COMPUTE_CLCOMPARISONKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/CL/ICLKernel.h"
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ICLTensor;
34 
35 /** Interface for the comparison kernel. */
36 class CLComparisonKernel : public ICLKernel
37 {
38 public:
39     /** Default constructor. */
40     CLComparisonKernel();
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLComparisonKernel(const CLComparisonKernel &) = delete;
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     CLComparisonKernel &operator=(const CLComparisonKernel &) = delete;
45     /** Allow instances of this class to be moved */
46     CLComparisonKernel(CLComparisonKernel &&) = default;
47     /** Allow instances of this class to be moved */
48     CLComparisonKernel &operator=(CLComparisonKernel &&) = default;
49     /** Default destructor */
50     ~CLComparisonKernel() = default;
51     /** Set the inputs and output tensors
52      *
53      * @param[in]  input1    Source tensor. Data types supported: All.
54      * @param[in]  input2    Source tensor. Data types supported: Same as @p input1.
55      * @param[out] output    Destination tensor. Data types supported: U8.
56      * @param[in]  operation Comparison operation to use.
57      */
58     void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation);
59     /** Set the inputs and output tensors
60      *
61      * @param[in]  compile_context The compile context to be used.
62      * @param[in]  input1          Source tensor. Data types supported: All.
63      * @param[in]  input2          Source tensor. Data types supported: Same as @p input1.
64      * @param[out] output          Destination tensor. Data types supported: U8.
65      * @param[in]  operation       Comparison operation to use.
66      */
67     void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation);
68     /** Static function to check if given info will lead to a valid configuration of @ref CLComparisonKernel
69      *
70      * @param[in] input1    Source tensor. Data types supported: All.
71      * @param[in] input2    Source tensor. Data types supported: Same as @p input1.
72      * @param[in] output    Destination tensor. Data types supported: U8.
73      * @param[in] operation Comparison operation to use.
74      *
75      * @return a status
76      */
77     static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ComparisonOperation operation);
78 
79     // Inherited methods overridden:
80     void run(const Window &window, cl::CommandQueue &queue) override;
81     BorderSize border_size() const override;
82 
83 private:
84     const ICLTensor *_input1; /**< Source tensor 1 */
85     const ICLTensor *_input2; /**< Source tensor 2 */
86     ICLTensor       *_output; /**< Destination tensor */
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_CLCOMPARISONKERNEL_H */
90