Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 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 | */ |
| 24 | #ifndef __ARM_COMPUTE_CLPIXELWISEMULTIPLICATION_H__ |
| 25 | #define __ARM_COMPUTE_CLPIXELWISEMULTIPLICATION_H__ |
| 26 | |
| 27 | #include "arm_compute/core/Types.h" |
| 28 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | class ICLTensor; |
| 33 | |
| 34 | /** Basic function to run @ref CLPixelWiseMultiplicationKernel. */ |
| 35 | class CLPixelWiseMultiplication : public ICLSimpleFunction |
| 36 | { |
| 37 | public: |
| 38 | /** Initialise the kernel's inputs, output and convertion policy. |
| 39 | * |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 40 | * @param[in, out] input1 An input tensor. Data types supported: U8/QS8/QS16/S16/F16/F32. |
| 41 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
| 42 | * @param[in, out] input2 An input tensor. Data types supported: same as @p input1. |
| 43 | * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. |
| 44 | * @param[out] output The output tensor, Data types supported: same as @p input1. Note: U8 (QS8, QS16) requires both inputs to be U8 (QS8, QS16). |
| 45 | * @param[in] scale Scale to apply after multiplication. |
| 46 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. For QS8 and QS16 scale must be 1. |
| 47 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 48 | * @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] | 49 | */ |
Michele Di Giorgio | 6259e5f | 2018-01-17 17:29:33 +0000 | [diff] [blame] | 50 | void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, float scale, |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 51 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy); |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 52 | /** Static function to check if given info will lead to a valid configuration of @ref CLPixelWiseMultiplication |
| 53 | * |
| 54 | * @param[in] input1 An input tensor info. Data types supported: U8/QS8/QS16/S16/F16/F32. |
| 55 | * @param[in] input2 An input tensor info. Data types supported: same as @p input1. |
| 56 | * @param[in] output The output tensor info, Data types supported: same as @p input1. Note: U8 (QS8, QS16) requires both inputs to be U8 (QS8, QS16). |
| 57 | * @param[in] scale Scale to apply after multiplication. |
| 58 | * Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15. For QS8 and QS16 scale must be 1. |
| 59 | * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate |
| 60 | * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even. |
| 61 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 62 | * @return a status |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 63 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 64 | static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float scale, |
| 65 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 66 | }; |
| 67 | } |
| 68 | #endif /*__ARM_COMPUTE_CLPIXELWISEMULTIPLICATION_H__ */ |