Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 78c0090 | 2018-01-09 17:33:11 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-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_CLGEMMMATRIXADDITIONKERNEL_H__ |
| 25 | #define __ARM_COMPUTE_CLGEMMMATRIXADDITIONKERNEL_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | |
| 29 | namespace arm_compute |
| 30 | { |
| 31 | class ICLTensor; |
| 32 | |
| 33 | /** OpenCL kernel to perform the in-place matrix addition between 2 matrices, taking into account that the second matrix might be weighted by a scalar value beta. |
| 34 | * The matrices must have the same dimensions |
| 35 | * |
| 36 | * @note This kernel is computed if and only if beta != 0.0. |
| 37 | */ |
| 38 | class CLGEMMMatrixAdditionKernel : public ICLKernel |
| 39 | { |
| 40 | public: |
| 41 | /** Default constructor */ |
| 42 | CLGEMMMatrixAdditionKernel(); |
| 43 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 44 | CLGEMMMatrixAdditionKernel(const CLGEMMMatrixAdditionKernel &) = delete; |
| 45 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 46 | CLGEMMMatrixAdditionKernel &operator=(const CLGEMMMatrixAdditionKernel &) = delete; |
| 47 | /** Allow instances of this class to be moved */ |
| 48 | CLGEMMMatrixAdditionKernel(CLGEMMMatrixAdditionKernel &&) = default; |
| 49 | /** Allow instances of this class to be moved */ |
| 50 | CLGEMMMatrixAdditionKernel &operator=(CLGEMMMatrixAdditionKernel &&) = default; |
| 51 | /** Initialise the kernel's input, output and beta value |
| 52 | * |
| 53 | * @note The input and output tensors must have the same dimensions |
| 54 | * |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 55 | * @param[in] input Input tensor (Matrix C). Data types supported: F16/F32 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 56 | * @param[in, out] output Output tensor. If this kernel is used to finalize the GEMM result (alpha * AB + beta * C), output must contain the result obtained by @ref CLGEMMMatrixMultiplyKernel. Data type supported: same as @p input |
| 57 | * @param[in] beta Weight of matrix C |
| 58 | */ |
| 59 | void configure(const ICLTensor *input, ICLTensor *output, float beta); |
Georgios Pinitas | 78c0090 | 2018-01-09 17:33:11 +0000 | [diff] [blame] | 60 | /** Static function to check if given info will lead to a valid configuration of @ref CLGEMMMatrixAdditionKernel. |
| 61 | * |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 62 | * @param[in] input Input tensor (Matrix C). Data types supported: F16/F32 |
Georgios Pinitas | 78c0090 | 2018-01-09 17:33:11 +0000 | [diff] [blame] | 63 | * @param[in] output Output tensor. If this kernel is used to finalize the GEMM result (alpha * AB + beta * C), output must contain the result obtained by @ref CLGEMMMatrixMultiplyKernel. Data type supported: same as @p input |
| 64 | * @param[in] beta Weight of matrix C |
| 65 | * |
| 66 | * @return a status |
| 67 | */ |
Gian Marco Iodice | 750641d | 2018-05-08 12:01:57 +0100 | [diff] [blame] | 68 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 69 | |
| 70 | // Inherited methods overridden: |
| 71 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 72 | |
| 73 | private: |
| 74 | const ICLTensor *_input; |
| 75 | ICLTensor *_output; |
| 76 | }; |
Gian Marco Iodice | f670a0a | 2017-09-18 12:20:45 +0100 | [diff] [blame] | 77 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 78 | #endif /* __ARM_COMPUTE_CLGEMMMATRIXADDITIONKERNEL_H__ */ |