Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | cbbed28 | 2019-12-20 13:26:08 +0000 | [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_CLPIXELWISEMULTIPLICATION_H |
| 25 | #define ARM_COMPUTE_CLPIXELWISEMULTIPLICATION_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/Types.h" |
| 28 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 32 | // Forward declaration |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | class ICLTensor; |
| 34 | |
| 35 | /** Basic function to run @ref CLPixelWiseMultiplicationKernel. */ |
| 36 | class CLPixelWiseMultiplication : public ICLSimpleFunction |
| 37 | { |
| 38 | public: |
| 39 | /** Initialise the kernel's inputs, output and convertion policy. |
| 40 | * |
Michele Di Giorgio | cbbed28 | 2019-12-20 13:26:08 +0000 | [diff] [blame] | 41 | * @param[in, out] input1 An input tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/F32. |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 42 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
| 43 | * @param[in, out] input2 An input tensor. Data types supported: same as @p input1. |
| 44 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 45 | * @param[out] output The output tensor, Data types supported: same as @p input1. Note: U8 requires both inputs to be U8. |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 46 | * @param[in] scale Scale to apply after multiplication. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 47 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 48 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 49 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 50 | */ |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 51 | void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, float scale, |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 52 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy); |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 53 | /** Static function to check if given info will lead to a valid configuration of @ref CLPixelWiseMultiplication |
| 54 | * |
Michele Di Giorgio | cbbed28 | 2019-12-20 13:26:08 +0000 | [diff] [blame] | 55 | * @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] | 56 | * @param[in] input2 An input tensor info. Data types supported: same as @p input1. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 57 | * @param[in] output The output tensor info, Data types supported: same as @p input1. Note: U8 requires both inputs to be U8. |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 58 | * @param[in] scale Scale to apply after multiplication. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 59 | * 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] | 60 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 61 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
| 62 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 63 | * @return a status |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 64 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 65 | static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float scale, |
| 66 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 67 | }; |
Georgios Pinitas | 8be9148 | 2019-03-26 17:23:28 +0000 | [diff] [blame] | 68 | |
| 69 | /** Basic function to run @ref CLComplexPixelWiseMultiplicationKernel. */ |
| 70 | class CLComplexPixelWiseMultiplication : public ICLSimpleFunction |
| 71 | { |
| 72 | public: |
| 73 | /** Initialise the kernel's inputs, output. |
| 74 | * |
| 75 | * @param[in, out] input1 An input tensor. Data types supported: F32. Number of channels supported: 2. |
| 76 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
| 77 | * @param[in, out] input2 An input tensor. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 78 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
| 79 | * @param[out] output The output tensor, Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 80 | */ |
| 81 | void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output); |
| 82 | /** Static function to check if given info will lead to a valid configuration of @ref CLComplexPixelWiseMultiplication |
| 83 | * |
| 84 | * @param[in] input1 An input tensor info. Data types supported: F32. Number of channels supported: 2. |
| 85 | * @param[in] input2 An input tensor info. Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 86 | * @param[in] output The output tensor info, Data types supported: same as @p input1. Number of channels supported: same as @p input1. |
| 87 | */ |
| 88 | static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output); |
| 89 | }; |
| 90 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 91 | #endif /*ARM_COMPUTE_CLPIXELWISEMULTIPLICATION_H */ |