Compute Library
 22.05
CLL2NormalizeLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CLL2NORMALIZELAYER_H
25 #define ARM_COMPUTE_CLL2NORMALIZELAYER_H
26 
27 #include "arm_compute/core/Types.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  */
51 {
52 public:
53  /** Constructor */
54  CLL2NormalizeLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
55  /** Default Destructor */
57  /** Prevent instances of this class from being copied (As this class contains pointers) */
58  CLL2NormalizeLayer(const CLL2NormalizeLayer &) = delete;
59  /** Default move constructor */
61  /** Prevent instances of this class from being copied (As this class contains pointers) */
63  /** Default move assignment operator */
65 
66  /** Set the input and output tensors.
67  *
68  * Valid data layouts:
69  * - NHWC
70  * - NCHW
71  *
72  * Valid data type configurations:
73  * |src |dst |
74  * |:--------|:---------|
75  * |F16 |F16 |
76  * |F32 |F32 |
77  *
78  * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
79  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
80  * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2
81  * @param[in] epsilon (Optional) Lower bound value for the normalization.
82  */
83  void configure(ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f);
84  /** Set the input and output tensors.
85  *
86  * @param[in] compile_context The compile context to be used.
87  * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
88  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
89  * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2
90  * @param[in] epsilon (Optional) Lower bound value for the normalization.
91  */
92  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f);
93 
94  /** Static function to check if given info will lead to a valid configuration of @ref CLL2NormalizeLayer.
95  *
96  * @param[in] input Source tensor info. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
97  * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
98  * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2
99  * @param[in] epsilon (Optional) Lower bound value for the normalization.
100  *
101  * @return a status
102  */
103  static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon = 1e-12f);
104 
105  // Inherited methods overridden:
106  void run() override;
107 
108 private:
109  MemoryGroup _memory_group;
110  CLReductionOperation _reduce_func;
111  std::unique_ptr<CLL2NormalizeLayerKernel> _normalize_kernel;
112  CLTensor _sumsq;
113 };
114 }
115 #endif /*ARM_COMPUTE_CLL2NORMALIZELAYER_H */
static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon=1e-12f)
Static function to check if given info will lead to a valid configuration of CLL2NormalizeLayer.
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
CLL2NormalizeLayer(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Constructor.
~CLL2NormalizeLayer()
Default Destructor.
void configure(ICLTensor *input, ICLTensor *output, int axis, float epsilon=1e-12f)
Set the input and output tensors.
CLL2NormalizeLayer & operator=(const CLL2NormalizeLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to perform a L2 normalization on a given axis.
void run() override
Run the kernels contained in the function.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Perform reduction operation.
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41