• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-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_CLFLATTENLAYERKERNEL_H
25 #define ARM_COMPUTE_CLFLATTENLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** OpenCL interface for the flatten kernel.*/
34 class CLFlattenLayerKernel : public ICLKernel
35 {
36 public:
37     /** Default constructor */
38     CLFlattenLayerKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     CLFlattenLayerKernel(const CLFlattenLayerKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLFlattenLayerKernel &operator=(const CLFlattenLayerKernel &) = delete;
43     /** Allow instances of this class to be moved */
44     CLFlattenLayerKernel(CLFlattenLayerKernel &&) = default;
45     /** Allow instances of this class to be moved */
46     CLFlattenLayerKernel &operator=(CLFlattenLayerKernel &&) = default;
47     /** Set the input and output of the kernel.
48      *
49      * @param[in]  input  First input tensor to flatten with at least 3 dimensions.
50      *                    The dimensions above the third will be interpreted as batches. Data types supported: All.
51      * @param[out] output Output tensor with shape [w*h*d, input_batches] where:
52      *                    w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input
53      */
54     void configure(const ICLTensor *input, ICLTensor *output);
55     /** Set the input and output of the kernel.
56      *
57      * @param[in]  compile_context The compile context to be used.
58      * @param[in]  input           First input tensor to flatten with at least 3 dimensions.
59      *                             The dimensions above the third will be interpreted as batches. Data types supported: All.
60      * @param[out] output          Output tensor with shape [w*h*d, input_batches] where:
61      *                    w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input
62      */
63     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
64     /** Static function to check if given info will lead to a valid configuration of @ref CLFlattenLayerKernel
65      *
66      * @param[in]  input  First input tensor to flatten with at least 3 dimensions.
67      *                    The dimensions above the third will be interpreted as batches. Data types supported: All.
68      * @param[out] output Output tensor with shape [w*h*d, input_batches] where:
69      *                    w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input
70      *
71      * @return a status
72      */
73     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
74 
75     // Inherited methods overridden:
76     void run(const Window &window, cl::CommandQueue &queue) override;
77 
78 public:
79     const ICLTensor *_input;
80     ICLTensor       *_output;
81 };
82 } // namespace arm_compute
83 #endif /*ARM_COMPUTE_CLFLATTENLAYERKERNEL_H */
84