• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2020 Arm Limited.
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_CLQLSTMLAYERVNORMALIZATIONKERNEL_H
25 #define ARM_COMPUTE_CLQLSTMLAYERVNORMALIZATIONKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the kernel to do layer normalization. */
34 class CLQLSTMLayerNormalizationKernel : public ICLKernel
35 {
36 public:
37     /** Default constructor */
38     CLQLSTMLayerNormalizationKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     CLQLSTMLayerNormalizationKernel(const CLQLSTMLayerNormalizationKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLQLSTMLayerNormalizationKernel &operator=(const CLQLSTMLayerNormalizationKernel &) = delete;
43     /** Allow instances of this class to be moved */
44     CLQLSTMLayerNormalizationKernel(CLQLSTMLayerNormalizationKernel &&) = default;
45     /** Allow instances of this class to be moved */
46     CLQLSTMLayerNormalizationKernel &operator=(CLQLSTMLayerNormalizationKernel &&) = default;
47     /** Default destructor */
48     ~CLQLSTMLayerNormalizationKernel() = default;
49     /** Initialise the kernel's input and outputs.
50      *
51      * @param[in]  input  Source tensor with 2 dimensions. Data types supported: QSYMM16.
52      * @param[out] output Destination tensor. Data type supported: same as @p input
53      * @param[in]  weight Weight tensor. Data types supported: Same as @p input.
54      * @param[in]  bias   Bias tensor. Data types supported: S32.
55      *
56      */
57     void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *weight, const ICLTensor *bias);
58     /** Initialise the kernel's input and outputs.
59      *
60      * @param[in]  compile_context The compile context to be used.
61      * @param[in]  input           Source tensor with 2 dimensions. Data types supported: QSYMM16.
62      * @param[out] output          Destination tensor. Data type supported: same as @p input
63      * @param[in]  weight          Weight tensor. Data types supported: Same as @p input.
64      * @param[in]  bias            Bias tensor. Data types supported: S32.
65      */
66     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *weight, const ICLTensor *bias);
67     /** Static function to check if given info will lead to a valid configuration of @ref CLQLSTMLayerNormalizationKernel
68      *
69      * @param[in] input  Source tensor info with 2 dimensions. Data types supported: QSYMM16.
70      * @param[in] output Destination info tensor. Data type supported: same as @p input
71      * @param[in] weight Weight info tensor. Data types supported: Same as @p input.
72      * @param[in] bias   Bias tensor info. Data types supported: S32.
73      *
74      * @return a status
75      */
76     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *weight, const ITensorInfo *bias);
77 
78     // Inherited methods overridden:
79     void run(const Window &window, cl::CommandQueue &queue) override;
80 
81 private:
82     const ICLTensor *_input;
83     const ICLTensor *_weight;
84     const ICLTensor *_bias;
85     ICLTensor       *_output;
86 };
87 } // namespace arm_compute
88 #endif /* ARM_COMPUTE_CLQLSTMLAYERVNORMALIZATIONKERNEL_H */
89