xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NELogicalKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 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_NELOGICALKERNEL_H
25 #define ARM_COMPUTE_NELOGICALKERNEL_H
26 
27 #include "src/core/KernelTypes.h"
28 #include "src/core/NEON/INEKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace kernels
33 {
34 /** Interface for the kernel to perform logical operations between two tensors
35  *
36  * Supported logical operations:
37  *  - AND
38  *  - OR
39  *  - NOT
40  */
41 class NELogicalKernel : public INEKernel
42 {
43 public:
44     /** Initialise the kernel's inputs and output
45      *
46      * @param[in]  input1 An input tensor. Data type supported: U8.
47      * @param[in]  input2 An input tensor. Data type supported: U8
48      * @param[out] output Output tensor. Data type supported: U8.
49      * @param[out] op     Logical operation to perform
50      */
51     void configure(const ITensorInfo *input1, const ITensorInfo *input2, ITensorInfo *output, LogicalOperation op);
52     /** Static function to check if given info will lead to a valid configuration of @ref NELogicalKernel
53      *
54      * @param[in] input1 An input tensor. Data type supported: U8.
55      * @param[in] input2 An input tensor. Data type supported: U8
56      * @param[in] output Output tensor. Data type supported: U8.
57      * @param[in] op     Logical operation to perform
58      *
59      * @return a status
60      */
61     static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, LogicalOperation op);
62 
63     // Inherited methods overridden:
64     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
65     const char *name() const override;
66 
67 private:
68     LogicalOperation _op{};
69 };
70 } // namespace kernels
71 } // namespace arm_compute
72 #endif /* ARM_COMPUTE_NELOGICALKERNEL_H */
73