Compute Library
 22.05
CLReshapeLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2021 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_CLRESHAPELAYER_H
25 #define ARM_COMPUTE_CLRESHAPELAYER_H
26 
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 class CLCompileContext;
34 class ICLTensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref opencl::kernels::ClReshapeKernel */
38 class CLReshapeLayer : public IFunction
39 {
40 public:
41  /** Default Constructor */
43  /** Default Destructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  CLReshapeLayer(const CLReshapeLayer &) = delete;
47  /** Default move constructor */
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  CLReshapeLayer &operator=(const CLReshapeLayer &) = delete;
51  /** Default move assignment operator */
53  /** Initialise the kernel's inputs and outputs
54  *
55  * Valid data layouts:
56  * - All
57  *
58  * Valid data type configurations:
59  * |src |dst |
60  * |:--------------|:--------------|
61  * |All |All |
62  *
63  * @param[in] input First tensor input. Data type supported: All
64  * @param[out] output Output tensor. Data type supported: Same as @p input
65  */
66  void configure(const ICLTensor *input, ICLTensor *output);
67  /** Initialise the kernel's inputs and outputs
68  *
69  * @param[in] compile_context The compile context to be used.
70  * @param[in] input First tensor input. Data type supported: All
71  * @param[out] output Output tensor. Data type supported: Same as @p input
72  */
73  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
74 
75  /** Static function to check if given info will lead to a valid configuration of @ref CLReshapeLayer
76  *
77  * @param[in] input First tensor info. Data type supported: All
78  * @param[in] output Output tensor info. Data type supported: Same as @p input
79  *
80  * @return a status
81  */
82  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
83 
84  // Inherited methods overridden:
85  void run() override;
86 
87 private:
88  struct Impl;
89  std::unique_ptr<Impl> _impl;
90 };
91 } // namespace arm_compute
92 #endif /*ARM_COMPUTE_CLRESHAPELAYER_H */
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLReshapeLayer.
Base class for all functions.
Definition: IFunction.h:30
CLReshapeLayer & operator=(const CLReshapeLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
void run() override
Run the kernels contained in the function.
CLReshapeLayer()
Default Constructor.
CLCompileContext class.
~CLReshapeLayer()
Default Destructor.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(const ICLTensor *input, ICLTensor *output)
Initialise the kernel&#39;s inputs and outputs.
Basic function to run opencl::kernels::ClReshapeKernel.