Compute Library
 21.02
NEMeanStdDevNormalizationKernel.h
Go to the documentation of this file.
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_NEMEANSTDDEVNORMALIZATIONKERNEL_H
25 #define ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONKERNEL_H
26 
28 
29 #ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
30 #include <arm_fp16.h>
31 #endif /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 
37 /** 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. */
39 {
40 public:
41  const char *name() const override
42  {
43  return "NEMeanStdDevNormalizationKernel";
44  }
45  /** Default constructor */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  /** Allow instances of this class to be moved */
53  /** Allow instances of this class to be moved */
55  /** Default destructor */
57  /** Initialise the kernel's input and outputs.
58  *
59  * @note If the output tensor is a nullptr, the normalization will be performed in-place.
60  *
61  * @param[in, out] input Source tensor with 2 dimensions. In case of @p output tensor = nullptr,
62  * this tensor will store the result of the normalization. Data types supported: F16/F32.
63  * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input
64  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
65  */
66  void configure(ITensor *input, ITensor *output = nullptr, float epsilon = 1e-8f);
67  /** Static function to check if given info will lead to a valid configuration of @ref NEMeanStdDevNormalizationKernel
68  *
69  * @param[in] input Source tensor info with 2 dimensions. In case of @p output tensor info = nullptr,
70  * this tensor will store the result of the normalization. Data types supported: F16/F32.
71  * @param[in] output (Optional) Destination tensor info. It can be nullptr in case of in-place computation. Data type supported: same as @p input
72  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
73  *
74  * @return a status
75  */
76  static Status validate(const ITensorInfo *input, const ITensorInfo *output = nullptr, float epsilon = 1e-8f);
77 
78  // Inherited methods overridden:
79  void run(const Window &window, const ThreadInfo &info) override;
80 
81 private:
82  /** Normalizes the input with respect to mean and standard deviation.
83  *
84  * @param[in] window Region on which to execute the kernel.
85  */
86  template <typename ScalarType, int size>
87  void mean_stddev_normalization(const Window &window);
88 
89  ITensor *_input;
90  ITensor *_output;
91  float _epsilon;
92 
93  using MeanStdDevNormFunction = void (NEMeanStdDevNormalizationKernel::*)(const Window &window);
94 
95  MeanStdDevNormFunction _func;
96 };
97 } // namespace arm_compute
98 #endif /* ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Interface for the kernel to normalize the input 2D tensor across the first dimension with respect to ...
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
~NEMeanStdDevNormalizationKernel()=default
Default destructor.
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
const char * name() const override
Name of the kernel.
NEMeanStdDevNormalizationKernel & operator=(const NEMeanStdDevNormalizationKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
static Status validate(const ITensorInfo *input, const ITensorInfo *output=nullptr, float epsilon=1e-8f)
Static function to check if given info will lead to a valid configuration of NEMeanStdDevNormalizatio...
void configure(ITensor *input, ITensor *output=nullptr, float epsilon=1e-8f)
Initialise the kernel&#39;s input and outputs.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:235
Describe a multidimensional execution window.
Definition: Window.h:39