Compute Library
 21.02
NEMeanStdDevNormalizationLayer.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_NEMEANSTDDEVNORMALIZATIONLAYER_H
25 #define ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 class ITensorInfo;
34 
35 /** Basic function to execute mean and standard deviation normalization by calling @ref NEMeanStdDevNormalizationKernel */
37 {
38 public:
39  /** Constructor */
41  /** Prevent instances of this class from being copied (As this class contains pointers) */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
47  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
49  /** Default destructor */
51  /** Initialise the function's input and outputs.
52  *
53  * @note If the output tensor is a nullptr, the normalization will be performed in-place.
54  *
55  * @param[in, out] input Input tensor with 2 dimensions. Data types supported: F16/F32.
56  * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input
57  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
58  */
59  void configure(ITensor *input, ITensor *output = nullptr, float epsilon = 1e-8f);
60  /** Static function to check if given info will lead to a valid configuration of @ref NEMeanStdDevNormalizationKernel
61  *
62  * @param[in] input Source tensor info with 2 dimensions. In case of @p output tensor info = nullptr,
63  * this tensor will store the result of the normalization. Data types supported: F16/F32.
64  * @param[in] output (Optional) Destination tensor info. It can be nullptr in case of in-place computation. Data type supported: same as @p input
65  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
66  *
67  * @return a status
68  */
69  static Status validate(const ITensorInfo *input, const ITensorInfo *output = nullptr, float epsilon = 1e-8f);
70 };
71 } // namespace arm_compute
72 #endif /*ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONLAYER_H */
Store the tensor'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.
void configure(ITensor *input, ITensor *output=nullptr, float epsilon=1e-8f)
Initialise the function's input and outputs.
Basic interface for functions which have a single Neon kernel and no border.
~NEMeanStdDevNormalizationLayer()
Default destructor.
Basic function to execute mean and standard deviation normalization by calling NEMeanStdDevNormalizat...
NEMeanStdDevNormalizationLayer()=default
Constructor.
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...
NEMeanStdDevNormalizationLayer & operator=(const NEMeanStdDevNormalizationLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...