Compute Library
 20.02.1
CLLocallyConnectedMatrixMultiplyKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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_CLLOCALLYCONNECTEDMATRIXMULTIPLYKERNEL_H
25 #define ARM_COMPUTE_CLLOCALLYCONNECTEDMATRIXMULTIPLYKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** OpenCL kernel to multiply each row of first tensor with low 2 dimensions of second tensor.
34  *
35  * @attention The second input tensor must have at least 2 dimensions (matrix)
36  *
37  */
39 {
40 public:
41  /** Default constructor */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Allow instances of this class to be moved */
49  /** Allow instances of this class to be moved */
51  /** Initialise the kernel's input, output and alpha
52  *
53  * @param[in] input0 First input tensor. Data types supported: F32
54  * @param[in] input1 Second input tensor. Data type supported: same as @p input0
55  * @param[out] output Output tensor to store the result. Data type supported: same as @p input0
56  */
57  void configure(const ICLTensor *input0, const ICLTensor *input1, ICLTensor *output);
58  /** Static function to check if given info will lead to a valid configuration of @ref CLLocallyConnectedMatrixMultiplyKernel
59  *
60  * @param[in] input0 First input tensor info. Data types supported: F32
61  * @param[in] input1 Second input tensor info. Data type supported: same as @p input0
62  * @param[in] output Output tensor info. Data type supported: same as @p input0
63  *
64  * @return a status
65  */
66  static Status validate(const ITensorInfo *input0, const ITensorInfo *input1, const ITensorInfo *output);
67 
68  // Inherited methods overridden:
69  void run(const Window &window, cl::CommandQueue &queue) override;
70 
71 private:
72  const ICLTensor *_input0;
73  const ICLTensor *_input1;
74  ICLTensor *_output;
75 };
76 } // namespace arm_compute
77 #endif /* ARM_COMPUTE_CLLOCALLYCONNECTEDMATRIXMULTIPLYKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void configure(const ICLTensor *input0, const ICLTensor *input1, ICLTensor *output)
Initialise the kernel's input, output and alpha.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:43
Copyright (c) 2017-2020 ARM Limited.
OpenCL kernel to multiply each row of first tensor with low 2 dimensions of second tensor.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
static Status validate(const ITensorInfo *input0, const ITensorInfo *input1, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLLocallyConnectedMatrix...
Describe a multidimensional execution window.
Definition: Window.h:39
CLLocallyConnectedMatrixMultiplyKernel & operator=(const CLLocallyConnectedMatrixMultiplyKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)