Compute Library
 21.02
NEL2NormalizeLayerKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_NEL2NORMALIZELAYERKERNEL_H
25 #define ARM_COMPUTE_NEL2NORMALIZELAYERKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for performing a L2 normalize on a given axis given the square sum of it in this axis */
35 {
36 public:
37  const char *name() const override
38  {
39  return "NEL2NormalizeLayerKernel";
40  }
41  /** Default constructor */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Allow instances of this class to be moved */
49  /** Allow instances of this class to be moved */
51  /** Default destructor */
52  ~NEL2NormalizeLayerKernel() = default;
53  /** Set the input and output tensors.
54  *
55  * @param[in] input Source tensor. Data types supported: F16/F32.
56  * @param[in] sum Sum values tensor. Data types supported: same as @p input.
57  * Sum will have the same number of dimensions as input.
58  * @param[out] output Destination tensor. Data types and data layouts supported: same as @p input.
59  * Output will have the same number of dimensions as input.
60  * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2
61  * @param[in] epsilon Lower bound value for the normalization.
62  */
63  void configure(const ITensor *input, const ITensor *sum, ITensor *output, int axis, float epsilon);
64 
65  /** Static function to check if given info will lead to a valid configuration of @ref NEL2NormalizeLayerKernel.
66  *
67  * @param[in] input Source tensor info. Data types supported: F16/F32.
68  * @param[in] sum Sum values tensor info. Data types supported: same as @p input.
69  * Sum will have the same number of dimensions as input.
70  * @param[in] output Destination tensor info. Data types and data layouts supported: same as @p input.
71  * Output will have the same number of dimensions as input.
72  * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2
73  * @param[in] epsilon Lower bound value for the normalization.
74  *
75  * @return a status
76  */
77  static Status validate(const ITensorInfo *input, const ITensorInfo *sum, const ITensorInfo *output, int axis, float epsilon);
78 
79  // Inherited methods overridden:
80  void run(const Window &window, const ThreadInfo &info) override;
81 
82 private:
83  const ITensor *_input;
84  const ITensor *_sum;
85  ITensor *_output;
86  unsigned int _actual_axis;
87  float _epsilon;
88 };
89 } // namespace arm_compute
90 #endif /*ARM_COMPUTE_NEL2NORMALIZELAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
const char * name() const override
Name of the kernel.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
DATA_TYPE sum(__global const DATA_TYPE *input)
Calculate sum of a vector.
Interface for performing a L2 normalize on a given axis given the square sum of it in this axis...
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
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.
NEL2NormalizeLayerKernel & operator=(const NEL2NormalizeLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
NEL2NormalizeLayerKernel()
Default constructor.
~NEL2NormalizeLayerKernel()=default
Default destructor.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
static Status validate(const ITensorInfo *input, const ITensorInfo *sum, const ITensorInfo *output, int axis, float epsilon)
Static function to check if given info will lead to a valid configuration of NEL2NormalizeLayerKernel...
Information about executing thread and CPU.
Definition: CPPTypes.h:235
Describe a multidimensional execution window.
Definition: Window.h:39
void configure(const ITensor *input, const ITensor *sum, ITensor *output, int axis, float epsilon)
Set the input and output tensors.