xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLBitwiseNot.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_CLBITWISENOT_H
25 #define ARM_COMPUTE_CLBITWISENOT_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 NOT by running @ref CLBitwiseKernel.
35  *
36  * @note The tensor data type for the inputs must be U8.
37  * @note The function performs a bitwise NOT operation on input tensor.
38  */
39 class CLBitwiseNot : public ICLSimpleFunction
40 {
41 public:
42     /** Initialize the function
43      * Valid data layouts:
44      * - All
45      *
46      * Valid data type configurations:
47      * |src            |dst            |
48      * |:--------------|:--------------|
49      * |U8             |U8             |
50      *
51      * @param[in]  input  Input tensor. Data types supported: U8.
52      * @param[out] output Output tensor. Data types supported: U8.
53      */
54     void configure(const ICLTensor *input, ICLTensor *output);
55     /** Initialize the function
56      *
57      * @param[in]  compile_context The compile context to be used.
58      * @param[in]  input           Input tensor. Data types supported: U8.
59      * @param[out] output          Output tensor. Data types supported: U8.
60      */
61     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
62 };
63 }
64 #endif /* ARM_COMPUTE_CLBITWISENOT_H */
65