1 /* 2 * Copyright (c) 2016-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_CLDERIVATIVEKERNEL_H 25 #define ARM_COMPUTE_CLDERIVATIVEKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 namespace arm_compute 30 { 31 class ICLTensor; 32 33 /** Interface for the derivative kernel. */ 34 class CLDerivativeKernel : public ICLKernel 35 { 36 public: 37 /** Default constructor */ 38 CLDerivativeKernel(); 39 /** Prevent instances of this class from being copied (As this class contains pointers) */ 40 CLDerivativeKernel(const CLDerivativeKernel &) = delete; 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLDerivativeKernel &operator=(const CLDerivativeKernel &) = delete; 43 /** Allow instances of this class to be moved */ 44 CLDerivativeKernel(CLDerivativeKernel &&) = default; 45 /** Allow instances of this class to be moved */ 46 CLDerivativeKernel &operator=(CLDerivativeKernel &&) = default; 47 /** Default destructor */ 48 ~CLDerivativeKernel() = default; 49 /** Initialise the kernel's sources, destination and border 50 * 51 * @note At least one of output_x or output_y must be set 52 * 53 * @param[in] input Source tensor. Data types supported: U8. 54 * @param[out] output_x (Optional) Destination tensor for the X gradient, Data types supported: S16. 55 * @param[out] output_y (Optional) Destination tensor for the Y gradient, Data types supported: S16. 56 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. 57 */ 58 void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined); 59 /** Initialise the kernel's sources, destination and border 60 * 61 * @note At least one of output_x or output_y must be set 62 * 63 * @param[in] compile_context The compile context to be used. 64 * @param[in] input Source tensor. Data types supported: U8. 65 * @param[out] output_x (Optional) Destination tensor for the X gradient, Data types supported: S16. 66 * @param[out] output_y (Optional) Destination tensor for the Y gradient, Data types supported: S16. 67 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. 68 */ 69 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined); 70 71 // Inherited methods overridden: 72 void run(const Window &window, cl::CommandQueue &queue) override; 73 BorderSize border_size() const override; 74 75 private: 76 const ICLTensor *_input; /**< Input tensor */ 77 ICLTensor *_output_x; /**< Output tensor - Derivate along the X direction */ 78 ICLTensor *_output_y; /**< Output tensor - Derivate along the Y direction */ 79 bool _run_derivative_x; /**< Do we need to run Derivative X ? */ 80 bool _run_derivative_y; /**< Do we need to run Derivative Y ? */ 81 }; 82 } // namespace arm_compute 83 #endif /*ARM_COMPUTE_CLDERIVATIVEKERNEL_H */ 84