xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NEBitwiseXorKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-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_NEBITWISEXORKERNEL_H
25 #define ARM_COMPUTE_NEBITWISEXORKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for the kernel to perform bitwise exclusive OR (XOR) between two tensors
34  *
35  * Result is computed by:
36  * @f[ output(x,y) = input1(x,y) \oplus input2(x,y) @f]
37  */
38 class NEBitwiseXorKernel : public INEKernel
39 {
40 public:
name()41     const char *name() const override
42     {
43         return "NEBitwiseXorKernel";
44     }
45     /** Default constructor */
46     NEBitwiseXorKernel();
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NEBitwiseXorKernel(const NEBitwiseXorKernel &) = delete;
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEBitwiseXorKernel &operator=(const NEBitwiseXorKernel &) = delete;
51     /** Allow instances of this class to be moved */
52     NEBitwiseXorKernel(NEBitwiseXorKernel &&) = default;
53     /** Allow instances of this class to be moved */
54     NEBitwiseXorKernel &operator=(NEBitwiseXorKernel &&) = default;
55     /** Default destructor */
56     ~NEBitwiseXorKernel() = default;
57     /** Initialise the kernel's input and output.
58      *
59      * @param[in]  input1 An input tensor. Data type supported: U8.
60      * @param[in]  input2 An input tensor. Data type supported: U8
61      * @param[out] output The output tensor. Data type supported: U8.
62      */
63     void configure(const ITensor *input1, const ITensor *input2, ITensor *output);
64 
65     // Inherited methods overridden:
66     void run(const Window &window, const ThreadInfo &info) override;
67 
68 private:
69     const ITensor *_input1; /**< Source tensor 1 */
70     const ITensor *_input2; /**< Source tensor 2 */
71     ITensor       *_output; /**< Destination tensor */
72 };
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_NEBITWISEXORKERNEL_H */
75