Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +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_NEGEMMMATRIXADDITIONKERNEL_H__ |
| 25 | #define __ARM_COMPUTE_NEGEMMMATRIXADDITIONKERNEL_H__ |
| 26 | |
| 27 | #include "arm_compute/core/NEON/INESimpleKernel.h" |
| 28 | |
| 29 | namespace arm_compute |
| 30 | { |
| 31 | class ITensor; |
| 32 | |
| 33 | /** NEON 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 | * |
| 35 | * @note [ MTX_OUT = MTX_0 + beta * MTX_1 ] with MTX_0 and MTX_1 of the same size |
| 36 | * |
| 37 | * @note This stage is used to finalize the GEMM result and it is computed if and only if beta != 0.0. In case this kernel is used for finalizing GEMM result, we have: |
| 38 | * - MTX_0 = A * B * alpha, where MTX_0 is the output of @ref NEGEMMMatrixMultiplyKernel |
| 39 | * - MTX_1 = C |
| 40 | */ |
| 41 | class NEGEMMMatrixAdditionKernel : public INESimpleKernel |
| 42 | { |
| 43 | public: |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 44 | const char *name() const override |
| 45 | { |
| 46 | return "NEGEMMMatrixAdditionKernel"; |
| 47 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 48 | /** Constructor */ |
| 49 | NEGEMMMatrixAdditionKernel(); |
| 50 | /** Prevent instances of this class from being copied */ |
| 51 | NEGEMMMatrixAdditionKernel(const NEGEMMMatrixAdditionKernel &) = delete; |
| 52 | /** Prevent instances of this class from being copied */ |
| 53 | NEGEMMMatrixAdditionKernel &operator=(const NEGEMMMatrixAdditionKernel &) = delete; |
| 54 | /** Allow instances of this class to be moved */ |
| 55 | NEGEMMMatrixAdditionKernel(NEGEMMMatrixAdditionKernel &&) = default; |
| 56 | /** Allow instances of this class to be moved */ |
| 57 | NEGEMMMatrixAdditionKernel &operator=(NEGEMMMatrixAdditionKernel &&) = default; |
| 58 | /** Initialise the kernel's input and output. |
| 59 | * |
| 60 | * @note The input and output tensor must have the same dimensions |
| 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 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 63 | * @param[in, out] output Output tensor. If this kernel is used to finalize the GEMM result, output contains the result obtained by the kernel @ref NEGEMMMatrixMultiplyKernel. Data type supported: the same as @p input. |
| 64 | * @param[in] beta Weight of matrix C |
| 65 | */ |
| 66 | void configure(const ITensor *input, ITensor *output, float beta); |
Georgios Pinitas | ea9e0dc | 2018-08-28 16:24:56 +0100 | [diff] [blame] | 67 | /** Static function to check if given info will lead to a valid configuration of @ref NEGEMMMatrixAdditionKernel. |
| 68 | * |
| 69 | * @note The input and output tensor must have the same dimensions |
| 70 | * |
| 71 | * @param[in] input Input tensor info (Matrix C). Data types supported: F16/F32 |
| 72 | * @param[in] output Output tensor info. If this kernel is used to finalize the GEMM result, output contains the result obtained by the kernel @ref NEGEMMMatrixMultiplyKernel. Data type supported: the same as @p input. |
| 73 | * @param[in] beta Weight of matrix C |
| 74 | * |
| 75 | * @return a status |
| 76 | */ |
| 77 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 78 | |
| 79 | // Inherited methods overridden: |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 80 | void run(const Window &window, const ThreadInfo &info) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 81 | |
| 82 | private: |
| 83 | /** Common signature for all the matrix addition functions |
| 84 | * |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 85 | * @param[in] input An input tensor. Data types supported: F16/F32 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 86 | * @param[out] output The output tensor. Data type supported: same as @p input |
| 87 | * @param[in] window Region on which to execute the kernel. |
| 88 | * @param[in] beta Weight of matrix C |
| 89 | */ |
| 90 | using MatrixAdditionFunction = void(const ITensor *input, ITensor *output, const Window &window, float beta); |
| 91 | /** Matrix addition function to use for the particular tensor types passed to configure() */ |
| 92 | MatrixAdditionFunction *_func; |
| 93 | float _beta; |
| 94 | }; |
Gian Marco Iodice | 356f643 | 2017-09-22 11:32:21 +0100 | [diff] [blame] | 95 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 96 | #endif /* __ARM_COMPUTE_NEGEMMMATRIXADDITIONKERNEL_H__ */ |