xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLBitwiseAnd.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-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_CLBITWISEAND_H
25 #define ARM_COMPUTE_CLBITWISEAND_H
26 
27 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
28 
29 namespace arm_compute
30 {
31 class CLCompileContext;
32 class ICLTensor;
33 
34 /** Basic function to perform bitwise AND by running @ref CLBitwiseKernel.
35  *
36  * @note The tensor data type for the inputs must be U8.
37  * @note The function performs a bitwise AND operation using the two input tensors.
38  */
39 class CLBitwiseAnd : public ICLSimpleFunction
40 {
41 public:
42     /** Initialize the function
43      *
44      * Valid data layouts:
45      * - All
46      *
47      * Valid data type configurations:
48      * |src            |dst            |
49      * |:--------------|:--------------|
50      * |U8             |U8             |
51      *
52      * @param[in]  input1 Input tensor. Data types supported: U8.
53      * @param[in]  input2 Input tensor. Data types supported: U8.
54      * @param[out] output Output tensor. Data types supported: U8.
55      */
56     void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output);
57     /** Initialize the function
58      *
59      * @param[in]  compile_context The compile context to be used.
60      * @param[in]  input1          Input tensor. Data types supported: U8.
61      * @param[in]  input2          Input tensor. Data types supported: U8.
62      * @param[out] output          Output tensor. Data types supported: U8.
63      */
64     void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output);
65 };
66 }
67 #endif /* ARM_COMPUTE_CLBITWISEAND_H */
68