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_CLPADLAYER_H 25 #define ARM_COMPUTE_CLPADLAYER_H 26 27 #include "arm_compute/core/Error.h" 28 #include "arm_compute/runtime/CL/CLTensor.h" 29 #include "arm_compute/runtime/IFunction.h" 30 31 namespace arm_compute 32 { 33 class CLCompileContext; 34 class CLPadLayerKernel; 35 class CLCopyKernel; 36 class ICLTensor; 37 38 /** Basic function to pad a tensor. This function calls the following OpenCL functions/kernels: 39 * 40 * -# @ref CLPadLayerKernel if there is padding to be added 41 * -# @ref CLCopyKernel otherwise 42 */ 43 class CLPadLayer : public IFunction 44 { 45 public: 46 /** Default constructor */ 47 CLPadLayer(); 48 /** Prevent instances of this class from being copied (As this class contains pointers) */ 49 CLPadLayer(const CLPadLayer &) = delete; 50 /** Default move constructor */ 51 CLPadLayer(CLPadLayer &&) = default; 52 /** Prevent instances of this class from being copied (As this class contains pointers) */ 53 CLPadLayer &operator=(const CLPadLayer &) = delete; 54 /** Default move assignment operator */ 55 CLPadLayer &operator=(CLPadLayer &&) = default; 56 /** Default destructor */ 57 ~CLPadLayer(); 58 59 /** Initialize the function 60 * 61 * @param[in] input Source tensor. Data types supported: All. 62 * @param[out] output Output tensor. Data type supported: same as @p input 63 * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i] 64 * specifies the front and the end padding in the i-th dimension. 65 * @param[in] constant_value (Optional) Constant value to be used for the padding. 66 * @param[in] mode (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT, 67 * or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT). 68 */ 69 void configure(ICLTensor *input, ICLTensor *output, const PaddingList &padding, PixelValue constant_value = PixelValue(), PaddingMode mode = PaddingMode::CONSTANT); 70 /** Initialize the function 71 * 72 * @param[in] compile_context The compile context to be used. 73 * @param[in] input Source tensor. Data types supported: All. 74 * @param[out] output Output tensor. Data type supported: same as @p input 75 * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i] 76 * specifies the front and the end padding in the i-th dimension. 77 * @param[in] constant_value (Optional) Constant value to be used for the padding. 78 * @param[in] mode (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT, 79 * or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT). 80 */ 81 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const PaddingList &padding, PixelValue constant_value = PixelValue(), 82 PaddingMode mode = PaddingMode::CONSTANT); 83 84 /** Static function to check if given info will lead to a valid configuration of @ref CLPadLayer. 85 * 86 * @param[in] input Source tensor info. Data types supported: All. 87 * @param[in] output Output tensor info. Data type supported: same as @p input 88 * @param[in] padding The padding for each spatial dimension of the input tensor. The pair padding[i] 89 * specifies the front and the end padding in the i-th dimension. 90 * @param[in] constant_value (Optional) Constant value to be used for the padding 91 * @param[in] mode (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT, 92 * or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT). 93 */ 94 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PaddingList &padding, PixelValue constant_value = PixelValue(), PaddingMode mode = PaddingMode::CONSTANT); 95 96 // Inherited methods overridden: 97 void run() override; 98 99 private: 100 void configure_reflect_mode(ICLTensor *input, ICLTensor *output); 101 102 std::unique_ptr<CLPadLayerKernel> _pad_kernel; 103 std::unique_ptr<CLCopyKernel> _copy_kernel; 104 bool _perform_pad; 105 }; 106 } // namespace arm_compute 107 #endif /*ARM_COMPUTE_PADLAYER_H */ 108