Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | d9eaf61 | 2020-07-08 11:12:57 +0100 | [diff] [blame^] | 2 | * Copyright (c) 2016-2020 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLPIXELWISEMULTIPLICATIONKERNEL_H |
| 25 | #define ARM_COMPUTE_CLPIXELWISEMULTIPLICATIONKERNEL_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | #include "arm_compute/core/Types.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 32 | // Forward declarations |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | class ICLTensor; |
| 34 | |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 35 | /** Interface for the pixelwise multiplication kernel. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 36 | class CLPixelWiseMultiplicationKernel : public ICLKernel |
| 37 | { |
| 38 | public: |
| 39 | /** Default constructor.*/ |
| 40 | CLPixelWiseMultiplicationKernel(); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 41 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 42 | CLPixelWiseMultiplicationKernel(const CLPixelWiseMultiplicationKernel &) = delete; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 43 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 44 | CLPixelWiseMultiplicationKernel &operator=(const CLPixelWiseMultiplicationKernel &) = delete; |
| 45 | /** Allow instances of this class to be moved */ |
| 46 | CLPixelWiseMultiplicationKernel(CLPixelWiseMultiplicationKernel &&) = default; |
| 47 | /** Allow instances of this class to be moved */ |
| 48 | CLPixelWiseMultiplicationKernel &operator=(CLPixelWiseMultiplicationKernel &&) = default; |
| 49 | /** Initialise the kernel's input, output and border mode. |
| 50 | * |
Michele Di Giorgio | cbbed28 | 2019-12-20 13:26:08 +0000 | [diff] [blame] | 51 | * @param[in] input1 An input tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/F32. |
Michele Di Giorgio | ab0a77e | 2017-06-21 15:36:24 +0100 | [diff] [blame] | 52 | * @param[in] input2 An input tensor. Data types supported: same as @p input1. |
Michele Di Giorgio | 7a0212a | 2020-04-14 16:08:32 +0100 | [diff] [blame] | 53 | * @param[out] output The output tensor, Data types supported: |
| 54 | * - U8, only if both input are U8 |
| 55 | * - QASYMM8, only if both inputs are QASYMM8 |
| 56 | * - QASYMM8_SIGNED, only if both inputs are QASYMM8_SIGNED |
| 57 | * - S16 |
| 58 | * - QSYMM16, only if both inputs are QSYMM16 |
| 59 | * - S32, only if both inputs are QSYMM16 |
| 60 | * - F16 |
| 61 | * - F32 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 62 | * @param[in] scale Scale to apply after multiplication. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 63 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 64 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 65 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 66 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 67 | */ |
| 68 | void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float scale, |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 69 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 70 | /** Initialise the kernel's input, output and border mode. |
| 71 | * |
| 72 | * @param[in] compile_context The compile context to be used. |
| 73 | * @param[in] input1 An input tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/F32. |
| 74 | * @param[in] input2 An input tensor. Data types supported: same as @p input1. |
| 75 | * @param[out] output The output tensor, Data types supported: same as @p input1. Note: U8 requires both inputs to be U8. |
| 76 | * @param[in] scale Scale to apply after multiplication. |
| 77 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. |
| 78 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 79 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
| 80 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
| 81 | */ |
Manuel Bottini | 679fc96 | 2020-04-21 16:08:53 +0100 | [diff] [blame] | 82 | void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float scale, |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 83 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 84 | /** Static function to check if given info will lead to a valid configuration of @ref CLPixelWiseMultiplicationKernel |
| 85 | * |
Michele Di Giorgio | cbbed28 | 2019-12-20 13:26:08 +0000 | [diff] [blame] | 86 | * @param[in] input1 An input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/F32. |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 87 | * @param[in] input2 An input tensor info. Data types supported: same as @p input1. |
Michele Di Giorgio | 7a0212a | 2020-04-14 16:08:32 +0100 | [diff] [blame] | 88 | * @param[in] output The output tensor info, Data types supported: |
| 89 | * - U8, only if both input are U8 |
| 90 | * - QASYMM8, only if both inputs are QASYMM8 |
| 91 | * - QASYMM8_SIGNED, only if both inputs are QASYMM8_SIGNED |
| 92 | * - S16 |
| 93 | * - QSYMM16, only if both inputs are QSYMM16 |
| 94 | * - S32, only if both inputs are QSYMM16 |
| 95 | * - F16 |
| 96 | * - F32 |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 97 | * @param[in] scale Scale to apply after multiplication. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 98 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 99 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 100 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 101 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 102 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 103 | * @return a status |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 104 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 105 | static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float scale, |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 106 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 107 | |
| 108 | // Inherited methods overridden: |
| 109 | void run(const Window &window, cl::CommandQueue &queue) override; |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 110 | BorderSize border_size() const override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 111 | |
| 112 | private: |
| 113 | const ICLTensor *_input1; |
| 114 | const ICLTensor *_input2; |
| 115 | ICLTensor *_output; |
| 116 | }; |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 117 | |
| 118 | /** Interface for the complex pixelwise multiplication kernel. */ |
| 119 | class CLComplexPixelWiseMultiplicationKernel : public ICLKernel |
| 120 | { |
| 121 | public: |
| 122 | /** Default constructor.*/ |
| 123 | CLComplexPixelWiseMultiplicationKernel(); |
| 124 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 125 | CLComplexPixelWiseMultiplicationKernel(const CLComplexPixelWiseMultiplicationKernel &) = delete; |
| 126 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 127 | CLComplexPixelWiseMultiplicationKernel &operator=(const CLComplexPixelWiseMultiplicationKernel &) = delete; |
| 128 | /** Allow instances of this class to be moved */ |
| 129 | CLComplexPixelWiseMultiplicationKernel(CLComplexPixelWiseMultiplicationKernel &&) = default; |
| 130 | /** Allow instances of this class to be moved */ |
| 131 | CLComplexPixelWiseMultiplicationKernel &operator=(CLComplexPixelWiseMultiplicationKernel &&) = default; |
| 132 | /** Initialise the kernel's input, output and border mode. |
| 133 | * |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 134 | * @param[in] input1 An input tensor. Data types supported: F32. Number of channels supported: 2. |
| 135 | * @param[in] input2 An input tensor. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 136 | * @param[out] output The output tensor, Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 137 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 138 | */ |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 139 | void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 140 | /** Initialise the kernel's input, output and border mode. |
| 141 | * |
| 142 | * @param[in] compile_context The compile context to be used. |
| 143 | * @param[in] input1 An input tensor. Data types supported: F32. Number of channels supported: 2. |
| 144 | * @param[in] input2 An input tensor. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 145 | * @param[out] output The output tensor, Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 146 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
| 147 | */ |
Manuel Bottini | 679fc96 | 2020-04-21 16:08:53 +0100 | [diff] [blame] | 148 | void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 149 | /** Static function to check if given info will lead to a valid configuration of @ref CLComplexPixelWiseMultiplicationKernel |
| 150 | * |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 151 | * @param[in] input1 An input tensor info. Data types supported: F32. Number of channels supported: 2. |
| 152 | * @param[in] input2 An input tensor info. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 153 | * @param[in] output The output tensor info. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 154 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 155 | * |
| 156 | * @return a status |
| 157 | */ |
Giorgio Arena | 8b2a7d3 | 2020-02-11 17:21:31 +0000 | [diff] [blame] | 158 | static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 159 | |
| 160 | // Inherited methods overridden: |
| 161 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 162 | BorderSize border_size() const override; |
| 163 | |
| 164 | private: |
| 165 | const ICLTensor *_input1; |
| 166 | const ICLTensor *_input2; |
| 167 | ICLTensor *_output; |
| 168 | }; |
Gian Marco Iodice | f670a0a | 2017-09-18 12:20:45 +0100 | [diff] [blame] | 169 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 170 | #endif /*ARM_COMPUTE_CLPIXELWISEMULTIPLICATIONKERNEL_H */ |