Compute Library
 21.05
ClCopy.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_CL_COPY_H
25 #define ARM_COMPUTE_CL_COPY_H
26 
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 /** Basic function to run @ref kernels::ClCopyKernel */
36 class ClCopy : public IClOperator
37 {
38 public:
39  /** Constructor */
40  ClCopy() = default;
41  /** Initialise the function's source and destination.
42  *
43  * @param[in] compile_context The compile context to be used.
44  * @param[in] src Source tensor info. Data types supported: All.
45  * @param[out] dst Output tensor info. Data types supported: Same as @p src.
46  * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr.
47  *
48  */
49  void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, Window *dst_window = nullptr);
50  /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClCopyKernel
51  *
52  * @param[in] src Source tensor info. Data types supported: All.
53  * @param[in] dst Output tensor info. Data types supported: Same as @p src.
54  * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr.
55  *
56  * @return a status
57  */
58  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Window *dst_window = nullptr);
59 };
60 } // namespace opencl
61 } // namespace arm_compute
62 #endif /* ARM_COMPUTE_CL_COPY_H */
void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, Window *dst_window=nullptr)
Initialise the function's source and destination.
Definition: ClCopy.cpp:33
ClCopy()=default
Constructor.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Window *dst_window=nullptr)
Static function to check if given info will lead to a valid configuration of kernels::ClCopyKernel.
Definition: ClCopy.cpp:40
CLCompileContext class.
Basic function to run kernels::ClCopyKernel.
Definition: ClCopy.h:36
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41
Describe a multidimensional execution window.
Definition: Window.h:39