Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 "arm_compute/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: |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 39 | const char *name() const override |
| 40 | { |
| 41 | return "NEDerivativeKernel"; |
| 42 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | /** Initialise the kernel's sources, destination and border |
| 54 | * |
| 55 | * @note At least one of output_x or output_y must be set |
| 56 | * |
| 57 | * @param[in] input Source tensor. Data type supported: U8. |
| 58 | * @param[out] output_x (Optional) Destination tensor for the X gradient. Data type supported: S16. |
| 59 | * @param[out] output_y (Optional) Destination tensor for the Y gradient. Data type supported: S16. |
| 60 | * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. |
| 61 | */ |
| 62 | void configure(const ITensor *input, ITensor *output_x, ITensor *output_y, bool border_undefined); |
| 63 | |
| 64 | // Inherited methods overridden: |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 65 | void run(const Window &window, const ThreadInfo &info) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 66 | BorderSize border_size() const override; |
| 67 | |
| 68 | private: |
| 69 | /** Function to perform derivative along the X direction on the given window |
| 70 | * |
Anthony Barbier | f202e50 | 2017-11-23 18:02:04 +0000 | [diff] [blame] | 71 | * @param[in] window Region on which to execute the kernel |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 72 | */ |
| 73 | void derivative_x(const Window &window); |
| 74 | /** Function to perform derivative along the Y direction on the given window |
| 75 | * |
Anthony Barbier | f202e50 | 2017-11-23 18:02:04 +0000 | [diff] [blame] | 76 | * @param[in] window Region on which to execute the kernel |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 77 | */ |
| 78 | void derivative_y(const Window &window); |
| 79 | /** Function to perform derivative along the X and Y direction on the given window |
| 80 | * |
Anthony Barbier | f202e50 | 2017-11-23 18:02:04 +0000 | [diff] [blame] | 81 | * @param[in] window Region on which to execute the kernel |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 82 | */ |
| 83 | void derivative_xy(const Window &window); |
| 84 | /** Common signature for all the specialised derivative functions |
| 85 | * |
| 86 | * @param[in] window Region on which to execute the kernel. |
| 87 | */ |
| 88 | using DerivativeFunction = void (NEDerivativeKernel::*)(const Window &window); |
| 89 | /** Derivative function to use for the particular tensor types passed to configure() */ |
| 90 | DerivativeFunction _func; |
| 91 | |
| 92 | private: |
| 93 | const ITensor *_input; /**< Input tensor */ |
| 94 | ITensor *_output_x; /**< Output tensor - Derivate along the X direction */ |
| 95 | ITensor *_output_y; /**< Output tensor - Derivate along the Y direction */ |
| 96 | }; |
Gian Marco Iodice | 356f643 | 2017-09-22 11:32:21 +0100 | [diff] [blame] | 97 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 98 | #endif /* __ARM_COMPUTE_NEDERIVATIVEKERNEL_H__ */ |