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_NEDERIVATIVE_H 25 #define ARM_COMPUTE_NEDERIVATIVE_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/IFunction.h" 29 30 #include <memory> 31 32 namespace arm_compute 33 { 34 class ITensor; 35 class NEDerivativeKernel; 36 class NEFillBorderKernel; 37 38 /** Basic function to execute first order derivative operator. This function calls the following NEON kernels: 39 * 40 * -# @ref NEFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) 41 * -# @ref NEDerivativeKernel 42 * 43 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 44 * 45 */ 46 class NEDerivative : public IFunction 47 { 48 public: 49 /** Default constructor */ 50 NEDerivative(); 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEDerivative(const NEDerivative &) = delete; 53 /** Prevent instances of this class from being copied (As this class contains pointers) */ 54 NEDerivative &operator=(const NEDerivative &) = delete; 55 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 56 NEDerivative(NEDerivative &&) = delete; 57 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 58 NEDerivative &operator=(NEDerivative &&) = delete; 59 /** Default destructor */ 60 ~NEDerivative(); 61 /** Initialise the function's source, destinations and border mode. 62 * 63 * @note At least one of output_x or output_y must be not NULL. 64 * 65 * @param[in, out] input Source tensor. Data type supported: U8. (Written to only for @p border_mode != UNDEFINED) 66 * @param[out] output_x (optional) Destination tensor. Derivative along the X direction. Data type supported: S16. 67 * @param[out] output_y (optional) Destination tensor. Derivative along the Y direction. Data type supported: S16. 68 * @param[in] border_mode Border mode to use 69 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 70 * 71 */ 72 void configure(ITensor *input, ITensor *output_x, ITensor *output_y, BorderMode border_mode, uint8_t constant_border_value = 0); 73 74 // Inherited methods overridden: 75 void run() override; 76 77 private: 78 std::unique_ptr<NEDerivativeKernel> _kernel; /**< Derivative kernel */ 79 std::unique_ptr<NEFillBorderKernel> _border_handler; /**< Kernel to handle tensor borders */ 80 }; 81 } 82 #endif /* ARM_COMPUTE_NEDERIVATIVE_H */ 83