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