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_NEDERIVATIVEKERNEL_H 25 #define ARM_COMPUTE_NEDERIVATIVEKERNEL_H 26 27 #include "src/core/NEON/INEKernel.h" 28 29 namespace arm_compute 30 { 31 class ITensor; 32 33 /** Interface for the kernel to run the derivative along the X/Y directions on a tensor. 34 * 35 */ 36 class NEDerivativeKernel : public INEKernel 37 { 38 public: name()39 const char *name() const override 40 { 41 return "NEDerivativeKernel"; 42 } 43 /** Default constructor */ 44 NEDerivativeKernel(); 45 /** Prevent instances of this class from being copied (As this class contains pointers) */ 46 NEDerivativeKernel(const NEDerivativeKernel &) = delete; 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 NEDerivativeKernel &operator=(const NEDerivativeKernel &) = delete; 49 /** Allow instances of this class to be moved */ 50 NEDerivativeKernel(NEDerivativeKernel &&) = default; 51 /** Allow instances of this class to be moved */ 52 NEDerivativeKernel &operator=(NEDerivativeKernel &&) = default; 53 /** Default destructor */ 54 ~NEDerivativeKernel() = default; 55 /** Initialise the kernel's sources, destination and border 56 * 57 * @note At least one of output_x or output_y must be set 58 * 59 * @param[in] input Source tensor. Data type supported: U8. 60 * @param[out] output_x (Optional) Destination tensor for the X gradient. Data type supported: S16. 61 * @param[out] output_y (Optional) Destination tensor for the Y gradient. Data type supported: S16. 62 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. 63 */ 64 void configure(const ITensor *input, ITensor *output_x, ITensor *output_y, bool border_undefined); 65 66 // Inherited methods overridden: 67 void run(const Window &window, const ThreadInfo &info) override; 68 BorderSize border_size() const override; 69 70 private: 71 /** Function to perform derivative along the X direction on the given window 72 * 73 * @param[in] window Region on which to execute the kernel 74 */ 75 void derivative_x(const Window &window); 76 /** Function to perform derivative along the Y direction on the given window 77 * 78 * @param[in] window Region on which to execute the kernel 79 */ 80 void derivative_y(const Window &window); 81 /** Function to perform derivative along the X and Y direction on the given window 82 * 83 * @param[in] window Region on which to execute the kernel 84 */ 85 void derivative_xy(const Window &window); 86 /** Common signature for all the specialised derivative functions 87 * 88 * @param[in] window Region on which to execute the kernel. 89 */ 90 using DerivativeFunction = void (NEDerivativeKernel::*)(const Window &window); 91 /** Derivative function to use for the particular tensor types passed to configure() */ 92 DerivativeFunction _func; 93 94 private: 95 const ITensor *_input; /**< Input tensor */ 96 ITensor *_output_x; /**< Output tensor - Derivate along the X direction */ 97 ITensor *_output_y; /**< Output tensor - Derivate along the Y direction */ 98 }; 99 } // namespace arm_compute 100 #endif /* ARM_COMPUTE_NEDERIVATIVEKERNEL_H */ 101