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_CLCOPYKERNEL_H 25 #define ARM_COMPUTE_CLCOPYKERNEL_H 26 27 #include "arm_compute/core/Types.h" 28 #include "src/core/CL/ICLKernel.h" 29 30 namespace arm_compute 31 { 32 class ICLTensor; 33 34 /** OpenCL kernel to perform a copy between two tensors */ 35 class CLCopyKernel : public ICLKernel 36 { 37 public: 38 /** Default constructor */ 39 CLCopyKernel(); 40 /** Prevent instances of this class from being copied (As this class contains pointers). */ 41 CLCopyKernel(const CLCopyKernel &) = delete; 42 /** Prevent instances of this class from being copied (As this class contains pointers). */ 43 CLCopyKernel &operator=(const CLCopyKernel &) = delete; 44 /** Allow instances of this class to be moved */ 45 CLCopyKernel(CLCopyKernel &&) = default; 46 /** Allow instances of this class to be moved */ 47 CLCopyKernel &operator=(CLCopyKernel &&) = default; 48 /** Initialize the kernel's input, output. 49 * 50 * @param[in] input Source tensor. Data types supported: All. 51 * @param[out] output Destination tensor. Data types supported: same as @p input. 52 * @param[in] output_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. 53 */ 54 void configure(const ICLTensor *input, ICLTensor *output, Window *output_window = nullptr); 55 /** Initialize the kernel's input, output. 56 * 57 * @param[in] compile_context The compile context to be used. 58 * @param[in] input Source tensor. Data types supported: All. 59 * @param[out] output Destination tensor. Data types supported: same as @p input. 60 * @param[in] output_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. 61 */ 62 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, Window *output_window = nullptr); 63 /** Static function to check if given info will lead to a valid configuration of @ref CLCopyKernel 64 * 65 * @param[in] input Source tensor info. Data types supported: All. 66 * @param[in] output Destination tensor info. Data types supported: same as @p input. 67 * @param[in] output_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. 68 * 69 * @return a status 70 */ 71 static Status validate(const ITensorInfo *input, const ITensorInfo *output, Window *output_window = nullptr); 72 73 // Inherited methods overridden: 74 void run(const Window &window, cl::CommandQueue &queue) override; 75 76 private: 77 const ICLTensor *_input; 78 ICLTensor *_output; 79 Window _output_window; 80 bool _has_output_window; 81 }; 82 } // namespace arm_compute 83 #endif /*ARM_COMPUTE_CLCOPYKERNEL_H */ 84