Compute Library
 22.05
CLMeanStdDevNormalizationLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2021 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_CLMEANSTDDEVNORMALIZATIONLAYER_H
25 #define ARM_COMPUTE_CLMEANSTDDEVNORMALIZATIONLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to execute mean and standard deviation normalization by calling @ref CLMeanStdDevNormalizationKernel */
38 {
39 public:
40  /** Initialise the function's input and outputs.
41  *
42  * Valid data layouts:
43  * - NHWC
44  * - NCHW
45  *
46  * Valid data type configurations:
47  * |src |dst |
48  * |:--------|:---------|
49  * |F32 |F32 |
50  * |F16 |F16 |
51  *
52  * @note If the output tensor is a nullptr, the normalization will be performed in-place.
53  *
54  * @param[in, out] input Input tensor with 2 dimensions. 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 function'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 Input tensor with 2 dimensions. Data types supported: F16/F32.
65  * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input
66  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
67  */
68  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output = nullptr, float epsilon = 1e-8f);
69  /** Static function to check if given info will lead to a valid configuration of @ref CLMeanStdDevNormalizationKernel
70  *
71  * @param[in] input Source tensor info with 2 dimensions. In case of @p output tensor info = nullptr,
72  * this tensor will store the result of the normalization. Data types supported: F16/F32.
73  * @param[in] output (Optional) Destination tensor info. It can be nullptr in case of in-place computation. Data type supported: same as @p input
74  * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8.
75  *
76  * @return a status
77  */
78  static Status validate(const ITensorInfo *input, const ITensorInfo *output = nullptr, float epsilon = 1e-8f);
79 };
80 } // namespace arm_compute
81 #endif /*ARM_COMPUTE_CLMEANSTDDEVNORMALIZATIONLAYER_H */
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 CLMeanStdDevNormalizatio...
Basic function to execute mean and standard deviation normalization by calling CLMeanStdDevNormalizat...
Store the tensor's metadata.
Definition: ITensorInfo.h:40
void configure(ICLTensor *input, ICLTensor *output=nullptr, float epsilon=1e-8f)
Initialise the function's input and outputs.
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single OpenCL kernel.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42