Georgios Pinitas | aaa2718 | 2018-11-21 16:32:15 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 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/CL/ICLKernel.h" |
| 28 | #include "arm_compute/core/Types.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 */ |
| 44 | CLSelectKernel(); |
| 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 */ |
| 52 | CLSelectKernel &operator=(CLSelectKernel &&) = default; |
| 53 | /** Default destructor */ |
| 54 | ~CLSelectKernel() = default; |
| 55 | /** Initialise the kernel's inputs and output. |
| 56 | * |
| 57 | * @param[in] c Condition input tensor. Data types supported: U8. |
| 58 | * @param[in] x First input tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32. |
| 59 | * @param[out] y Second input tensor. Data types supported: Same as @p x |
| 60 | * @param[in] output Output tensor. Data types supported: Same as @p x. |
| 61 | */ |
| 62 | void configure(const ICLTensor *c, const ICLTensor *x, const ICLTensor *y, ICLTensor *output); |
| 63 | /** Static function to check if given info will lead to a valid configuration of @ref CLSelectKernel |
| 64 | * |
| 65 | * @param[in] c Condition input tensor. Data types supported: U8. |
| 66 | * @param[in] x First input tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32. |
| 67 | * @param[in] y Second input tensor. Data types supported: Same as @p x |
| 68 | * @param[in] output Output tensor. Data types supported: Same as @p x. |
| 69 | * |
| 70 | * @return a status |
| 71 | */ |
| 72 | static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output); |
| 73 | |
| 74 | // Inherited methods overridden: |
| 75 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 76 | |
| 77 | private: |
| 78 | const ICLTensor *_c; /**< Condition tensor */ |
| 79 | const ICLTensor *_x; /**< Source tensor 1 */ |
| 80 | const ICLTensor *_y; /**< Source tensor 2 */ |
| 81 | ICLTensor *_output; /**< Destination tensor */ |
| 82 | bool _has_same_rank; /**< Flag that indicates if condition tensor and other inputs have the same rank */ |
| 83 | }; |
| 84 | } // namespace arm_compute |
| 85 | #endif /* __ARM_COMPUTE_CLWHEREKERNEL_H__ */ |