Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 1 | /* |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 2 | * Copyright (c) 2018-2021 Arm Limited. |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLCOPY_H |
| 25 | #define ARM_COMPUTE_CLCOPY_H |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/Types.h" |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 28 | #include "arm_compute/core/Window.h" |
| 29 | #include "arm_compute/runtime/IFunction.h" |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 30 | |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 31 | #include <memory> |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 32 | |
| 33 | namespace arm_compute |
| 34 | { |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 35 | class CLCompileContext; |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 36 | class ICLTensor; |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 37 | class ITensorInfo; |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 38 | |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 39 | /** Basic function to run @ref opencl::kernels::ClCopyKernel */ |
| 40 | class CLCopy : public IFunction |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 41 | { |
| 42 | public: |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 43 | /** Constructor */ |
| 44 | CLCopy(); |
| 45 | /** Destructor */ |
| 46 | ~CLCopy(); |
| 47 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 48 | CLCopy(const CLCopy &) = delete; |
| 49 | /** Default move constructor */ |
| 50 | CLCopy(CLCopy &&); |
| 51 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 52 | CLCopy &operator=(const CLCopy &) = delete; |
| 53 | /** Default move assignment operator */ |
| 54 | CLCopy &operator=(CLCopy &&); |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 55 | /** Initialise the function's source and destination. |
| 56 | * |
Sheri Zhang | a47dcc2 | 2021-04-22 14:41:12 +0100 | [diff] [blame] | 57 | * Valid data layouts: |
| 58 | * - All |
| 59 | * |
| 60 | * Valid data type configurations: |
| 61 | * |src |dst | |
| 62 | * |:--------------|:--------------| |
| 63 | * |All |All | |
| 64 | * |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 65 | * @param[in] input Source tensor. Data types supported: All. |
| 66 | * @param[out] output Output tensor. Data types supported: Same as @p input. |
| 67 | * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 68 | */ |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 69 | void configure(ICLTensor *input, ICLTensor *output, Window *dst_window = nullptr); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 70 | /** Initialise the function's source and destination. |
| 71 | * |
| 72 | * @param[in] compile_context The compile context to be used. |
Michele Di Giorgio | f6f7876 | 2020-07-06 11:27:21 +0100 | [diff] [blame] | 73 | * @param[in] input Source tensor. Data types supported: All. |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 74 | * @param[out] output Output tensor. Data types supported: Same as @p input. |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 75 | * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 76 | * |
| 77 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 78 | void configure(const CLCompileContext &compile_context, |
| 79 | ICLTensor *input, |
| 80 | ICLTensor *output, |
| 81 | Window *dst_window = nullptr); |
Georgios Pinitas | 8bc745d | 2018-07-18 19:51:24 +0100 | [diff] [blame] | 82 | /** Static function to check if given info will lead to a valid configuration of @ref CLCopy |
| 83 | * |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 84 | * @param[in] input Source tensor. Data types supported: All. |
| 85 | * @param[in] output Output tensor. Data types supported: Same as @p input. |
| 86 | * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. |
Georgios Pinitas | 8bc745d | 2018-07-18 19:51:24 +0100 | [diff] [blame] | 87 | * |
| 88 | * @return a status |
| 89 | */ |
Sheri Zhang | 7e20e29 | 2021-02-02 11:49:34 +0000 | [diff] [blame] | 90 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, Window *dst_window = nullptr); |
| 91 | |
| 92 | // Inherited methods overridden: |
| 93 | void run() override; |
| 94 | |
| 95 | private: |
| 96 | struct Impl; |
| 97 | std::unique_ptr<Impl> _impl; |
Michalis Spyrou | 5c8e05c | 2018-03-22 11:56:01 +0000 | [diff] [blame] | 98 | }; |
| 99 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 100 | #endif /*ARM_COMPUTE_CLCOPY_H */ |