1 /* 2 * Copyright (c) 2019-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_CLMEANSTDDEVNORMALIZATIONKERNEL_H 25 #define ARM_COMPUTE_CLMEANSTDDEVNORMALIZATIONKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 namespace arm_compute 30 { 31 class ICLTensor; 32 33 /** Interface for the kernel to normalize the input 2D tensor across the first dimension with respect to mean and standard deviation of the same dimension. */ 34 class CLMeanStdDevNormalizationKernel : public ICLKernel 35 { 36 public: 37 /** Default constructor */ 38 CLMeanStdDevNormalizationKernel(); 39 /** Prevent instances of this class from being copied (As this class contains pointers) */ 40 CLMeanStdDevNormalizationKernel(const CLMeanStdDevNormalizationKernel &) = delete; 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLMeanStdDevNormalizationKernel &operator=(const CLMeanStdDevNormalizationKernel &) = delete; 43 /** Allow instances of this class to be moved */ 44 CLMeanStdDevNormalizationKernel(CLMeanStdDevNormalizationKernel &&) = default; 45 /** Allow instances of this class to be moved */ 46 CLMeanStdDevNormalizationKernel &operator=(CLMeanStdDevNormalizationKernel &&) = default; 47 /** Default destructor */ 48 ~CLMeanStdDevNormalizationKernel() = default; 49 /** Initialise the kernel's input and outputs. 50 * 51 * @note If the output tensor is a nullptr, the normalization will be performed in-place. 52 * 53 * @param[in, out] input Source tensor with 2 dimensions. In case of @p output tensor = nullptr, 54 * this tensor will store the result of the normalization. Data types supported: F16/F32. 55 * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input 56 * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8. 57 */ 58 void configure(ICLTensor *input, ICLTensor *output = nullptr, float epsilon = 1e-8f); 59 /** Initialise the kernel's input and outputs. 60 * 61 * @note If the output tensor is a nullptr, the normalization will be performed in-place. 62 * 63 * @param[in] compile_context The compile context to be used. 64 * @param[in, out] input Source tensor with 2 dimensions. In case of @p output tensor = nullptr, 65 * this tensor will store the result of the normalization. Data types supported: F16/F32. 66 * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input 67 * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8. 68 */ 69 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output = nullptr, float epsilon = 1e-8f); 70 /** Static function to check if given info will lead to a valid configuration of @ref CLMeanStdDevNormalizationKernel 71 * 72 * @param[in] input Source tensor info with 2 dimensions. In case of @p output tensor info = nullptr, 73 * this tensor will store the result of the normalization. Data types supported: F16/F32. 74 * @param[in] output (Optional) Destination tensor info. It can be nullptr in case of in-place computation. Data type supported: same as @p input 75 * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8. 76 * 77 * @return a status 78 */ 79 static Status validate(const ITensorInfo *input, const ITensorInfo *output = nullptr, float epsilon = 1e-8f); 80 81 // Inherited methods overridden: 82 void run(const Window &window, cl::CommandQueue &queue) override; 83 84 private: 85 ICLTensor *_input; 86 ICLTensor *_output; 87 bool _run_in_place; 88 }; 89 } // namespace arm_compute 90 #endif /* ARM_COMPUTE_CLMEANSTDDEVNORMALIZATIONKERNEL_H */ 91