1 /* 2 * Copyright (c) 2017-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_NENORMALIZATIONLAYER_H 25 #define ARM_COMPUTE_NENORMALIZATIONLAYER_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 #include "arm_compute/runtime/IMemoryManager.h" 31 #include "arm_compute/runtime/MemoryGroup.h" 32 #include "arm_compute/runtime/NEON/functions/NEPixelWiseMultiplication.h" 33 #include "arm_compute/runtime/Tensor.h" 34 35 #include <memory> 36 37 namespace arm_compute 38 { 39 class ITensor; 40 class NENormalizationLayerKernel; 41 42 /** Basic function to compute a normalization layer. This function calls the following NEON kernels: 43 * 44 * -# @ref NEPixelWiseMultiplication 45 * -# @ref NEFillBorderKernel 46 * -# @ref NENormalizationLayerKernel 47 * 48 */ 49 class NENormalizationLayer : public IFunction 50 { 51 public: 52 /** Default constructor */ 53 NENormalizationLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 54 /** Prevent instances of this class from being copied (As this class contains pointers) */ 55 NENormalizationLayer(const NENormalizationLayer &) = delete; 56 /** Prevent instances of this class from being copied (As this class contains pointers) */ 57 NENormalizationLayer &operator=(const NENormalizationLayer &) = delete; 58 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 59 NENormalizationLayer(NENormalizationLayer &&) = delete; 60 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 61 NENormalizationLayer &operator=(NENormalizationLayer &&) = delete; 62 /** Default destructor */ 63 ~NENormalizationLayer(); 64 /** Set the input and output tensors. 65 * 66 * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM], 67 * and an optional 4th dimension for batch of inputs. Data type supported: F16/F32. Data layouts supported: NCHW/NHWC. 68 * @param[out] output Destination with the same dimensions, data type, data layout and number of channels of @p input 69 * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters. 70 */ 71 void configure(const ITensor *input, ITensor *output, const NormalizationLayerInfo &norm_info); 72 /** Static function to check if given info will lead to a valid configuration of @ref NENormalizationLayer 73 * 74 * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM], 75 * and an optional 4th dimension for batch of inputs. Data type supported: F16/F32. Data layouts supported: NCHW/NHWC. 76 * @param[in] output Destination with the same dimensions, data type, data layout and number of channels of @p input 77 * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters. 78 * 79 * @return a status 80 */ 81 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const NormalizationLayerInfo &norm_info); 82 83 // Inherited methods overridden: 84 void run() override; 85 86 private: 87 MemoryGroup _memory_group; /**< Function memory group */ 88 std::unique_ptr<NENormalizationLayerKernel> _norm_kernel; /**< Normalization layer kernel */ 89 NEPixelWiseMultiplication _multiply_f; /**< Pixel multiplication function */ 90 Tensor _input_squared; /**< The intermediate buffer which stores results of squaring input */ 91 }; 92 } 93 #endif /* ARM_COMPUTE_NENORMALIZATIONLAYER_H */ 94