Compute Library
 22.02
CLSelectKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLSELECTKERNEL_H
25 #define ARM_COMPUTE_CLSELECTKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/CL/ICLKernel.h"
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ICLTensor;
34 
35 /** OpenCL interface for executing the select kernel
36  *
37  * Select is computed by:
38  * @f[ output(i) = condition(i) ? x(i) : y(i) @f]
39  **/
40 class CLSelectKernel : public ICLKernel
41 {
42 public:
43  /** Default constructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  CLSelectKernel(const CLSelectKernel &) = delete;
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  CLSelectKernel &operator=(const CLSelectKernel &) = delete;
49  /** Allow instances of this class to be moved */
50  CLSelectKernel(CLSelectKernel &&) = default;
51  /** Allow instances of this class to be moved */
53  /** Default destructor */
54  ~CLSelectKernel() = default;
55  /** Initialise the kernel's inputs and output.
56  *
57  * @param[in] compile_context The compile context to be used.
58  * @param[in] c Condition input tensor. Data types supported: U8.
59  * @param[in] x First input tensor. Data types supported: All.
60  * @param[out] y Second input tensor. Data types supported: Same as @p x
61  * @param[in] output Output tensor. Data types supported: Same as @p x.
62  */
63  void configure(const CLCompileContext &compile_context, const ICLTensor *c, const ICLTensor *x, const ICLTensor *y, ICLTensor *output);
64  /** Static function to check if given info will lead to a valid configuration of @ref CLSelectKernel
65  *
66  * @param[in] c Condition input tensor. Data types supported: U8.
67  * @param[in] x First input tensor. Data types supported: All.
68  * @param[in] y Second input tensor. Data types supported: Same as @p x
69  * @param[in] output Output tensor. Data types supported: Same as @p x.
70  *
71  * @return a status
72  */
73  static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output);
74 
75  // Inherited methods overridden:
76  void run(const Window &window, cl::CommandQueue &queue) override;
77 
78 private:
79  const ICLTensor *_c; /**< Condition tensor */
80  const ICLTensor *_x; /**< Source tensor 1 */
81  const ICLTensor *_y; /**< Source tensor 2 */
82  ICLTensor *_output; /**< Destination tensor */
83  bool _has_same_rank; /**< Flag that indicates if condition tensor and other inputs have the same rank */
84 };
85 } // namespace arm_compute
86 #endif /* ARM_COMPUTE_CLWHEREKERNEL_H */
CLSelectKernel()
Default constructor.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
Copyright (c) 2017-2021 Arm Limited.
CLSelectKernel & operator=(const CLSelectKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
void configure(const CLCompileContext &compile_context, const ICLTensor *c, const ICLTensor *x, const ICLTensor *y, ICLTensor *output)
Initialise the kernel&#39;s inputs and output.
static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLSelectKernel.
CLCompileContext class.
OpenCL interface for executing the select kernel.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Describe a multidimensional execution window.
Definition: Window.h:39
~CLSelectKernel()=default
Default destructor.