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_CLL2NORMALIZELAYER_H 25 #define ARM_COMPUTE_CLL2NORMALIZELAYER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CL/CLTensor.h" 29 #include "arm_compute/runtime/CL/ICLSimpleFunction.h" 30 #include "arm_compute/runtime/CL/functions/CLReductionOperation.h" 31 #include "arm_compute/runtime/IMemoryManager.h" 32 #include "arm_compute/runtime/MemoryGroup.h" 33 34 #include <cstdint> 35 #include <memory> 36 37 namespace arm_compute 38 { 39 class CLCompileContext; 40 class CLL2NormalizeLayerKernel; 41 class ICLTensor; 42 class ITensorInfo; 43 44 /** Basic function to perform a L2 normalization on a given axis. 45 * 46 * This function runs the following kernels: 47 * -# @ref CLReductionOperation 48 * -# @ref CLL2NormalizeLayerKernel 49 */ 50 class CLL2NormalizeLayer : public IFunction 51 { 52 public: 53 /** Constructor */ 54 CLL2NormalizeLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 55 /** Default Destructor */ 56 ~CLL2NormalizeLayer(); 57 /** Prevent instances of this class from being copied (As this class contains pointers) */ 58 CLL2NormalizeLayer(const CLL2NormalizeLayer &) = delete; 59 /** Default move constructor */ 60 CLL2NormalizeLayer(CLL2NormalizeLayer &&) = default; 61 /** Prevent instances of this class from being copied (As this class contains pointers) */ 62 CLL2NormalizeLayer &operator=(const CLL2NormalizeLayer &) = delete; 63 /** Default move assignment operator */ 64 CLL2NormalizeLayer &operator=(CLL2NormalizeLayer &&) = default; 65 66 /** Set the input and output tensors. 67 * 68 * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 69 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 70 * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 71 * @param[in] epsilon (Optional) Lower bound value for the normalization. 72 */ 73 void configure(ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f); 74 /** Set the input and output tensors. 75 * 76 * @param[in] compile_context The compile context to be used. 77 * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 78 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 79 * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 80 * @param[in] epsilon (Optional) Lower bound value for the normalization. 81 */ 82 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f); 83 84 /** Static function to check if given info will lead to a valid configuration of @ref CLL2NormalizeLayer. 85 * 86 * @param[in] input Source tensor info. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 87 * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input. 88 * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 89 * @param[in] epsilon (Optional) Lower bound value for the normalization. 90 * 91 * @return a status 92 */ 93 static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon = 1e-12f); 94 95 // Inherited methods overridden: 96 void run() override; 97 98 private: 99 MemoryGroup _memory_group; 100 CLReductionOperation _reduce_func; 101 std::unique_ptr<CLL2NormalizeLayerKernel> _normalize_kernel; 102 CLTensor _sumsq; 103 }; 104 } 105 #endif /*ARM_COMPUTE_CLL2NORMALIZELAYER_H */ 106