Compute Library
 22.02
CLBitwiseKernel.h
Go to the documentation of this file.
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_CLBITWISEKERNEL_H
25 #define ARM_COMPUTE_CLBITWISEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the bitwise operation kernel.
34  *
35  * Result depends on the \ref BitwiseOperation and is computed by:
36  * AND operation: @f[ output(x,y) = input1(x,y) \land input2(x,y) @f]
37  * NOT operation: @f[ output(x,y) = \lnot input1(x,y) @f]
38  * OR operation: @f[ output(x,y) = input1(x,y) \lor input2(x,y) @f]
39  * XOR operation: @f[ output(x,y) = input1(x,y) \oplus input2(x,y) @f]
40  */
41 class CLBitwiseKernel : public ICLKernel
42 {
43 public:
44  /** Default constructor. */
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  CLBitwiseKernel(const CLBitwiseKernel &) = delete;
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  CLBitwiseKernel &operator=(const CLBitwiseKernel &) = delete;
50  /** Allow instances of this class to be moved */
51  CLBitwiseKernel(CLBitwiseKernel &&) = default;
52  /** Allow instances of this class to be moved */
54  /** Set the inputs and output tensors
55  *
56  * @param[in] compile_context The compile context to be used.
57  * @param[in] input1 Source tensor. Data types supported: U8.
58  * @param[in] input2 Source tensor. Data types supported: U8.
59  * @param[out] output Destination tensor. Data types supported: U8.
60  * @param[in] op Bitwise operation to perform. Supported: AND, OR, NOT, XOR.
61  */
62  void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, BitwiseOperation op);
63 
64  // Inherited methods overridden:
65  void run(const Window &window, cl::CommandQueue &queue) override;
66 
67 private:
68  const ICLTensor *_input1; /**< Source tensor 1 */
69  const ICLTensor *_input2; /**< Source tensor 2 */
70  ICLTensor *_output; /**< Destination tensor */
71 };
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CLBITWISEKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
CLBitwiseKernel & operator=(const CLBitwiseKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
CLBitwiseKernel()
Default constructor.
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
Copyright (c) 2017-2021 Arm Limited.
void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, BitwiseOperation op)
Set the inputs and output tensors.
Interface for the bitwise operation kernel.
BitwiseOperation
Available bitwise operations.
Definition: Types.h:502
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Describe a multidimensional execution window.
Definition: Window.h:39