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_CLMEMSETKERNEL_H 25 #define ARM_COMPUTE_CLMEMSETKERNEL_H 26 27 #include "arm_compute/core/PixelValue.h" 28 #include "arm_compute/core/Types.h" 29 #include "src/core/CL/ICLKernel.h" 30 31 namespace arm_compute 32 { 33 class ICLTensor; 34 35 /** Interface for filling the planes of a tensor */ 36 class CLMemsetKernel : public ICLKernel 37 { 38 public: 39 /** Default constructor */ 40 CLMemsetKernel(); 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLMemsetKernel(const CLMemsetKernel &) = delete; 43 /** Prevent instances of this class from being copied (As this class contains pointers) */ 44 CLMemsetKernel &operator=(const CLMemsetKernel &) = delete; 45 /** Allow instances of this class to be moved */ 46 CLMemsetKernel(CLMemsetKernel &&) = default; 47 /** Allow instances of this class to be moved */ 48 CLMemsetKernel &operator=(CLMemsetKernel &&) = default; 49 /** Default destructor */ 50 ~CLMemsetKernel() = default; 51 52 /** Initialise the kernel's tensor and filling value 53 * 54 * @param[in,out] tensor Input tensor to fill. Supported data types: All. 55 * @param[in] constant_value The value used to fill the planes of the tensor 56 * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr. 57 */ 58 void configure(ICLTensor *tensor, const PixelValue &constant_value, Window *window = nullptr); 59 /** Initialise the kernel's tensor and filling value 60 * 61 * @param[in] compile_context The compile context to be used. 62 * @param[in,out] tensor Input tensor to fill. Supported data types: All. 63 * @param[in] constant_value The value used to fill the planes of the tensor 64 * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr. 65 */ 66 void configure(const CLCompileContext &compile_context, ICLTensor *tensor, const PixelValue &constant_value, Window *window = nullptr); 67 /** Static function to check if given info will lead to a valid configuration of @ref CLMemsetKernel 68 * 69 * @param[in] tensor Source tensor info. Data types supported: All. 70 * @param[in] constant_value The value used to fill the planes of the tensor 71 * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr. 72 * 73 * @return a status 74 */ 75 static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr); 76 77 // Inherited methods overridden: 78 void run(const Window &window, cl::CommandQueue &queue) override; 79 80 private: 81 ICLTensor *_tensor; 82 Window _full_window; 83 }; 84 } // namespace arm_compute 85 #endif /*ARM_COMPUTE_CLMEMSETRKERNEL_H */ 86