Compute Library
 20.02.1
CLNormalizationLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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_CLNORMALIZATIONLAYER_H
25 #define ARM_COMPUTE_CLNORMALIZATIONLAYER_H
26 
28 
33 
34 #include "arm_compute/core/Types.h"
35 
36 namespace arm_compute
37 {
38 class ICLTensor;
39 
40 /** Basic function to compute a normalization layer. This function calls the following CL kernels:
41  *
42  * -# @ref CLFillBorderKernel
43  * -# @ref CLNormalizationLayerKernel
44  *
45  */
47 {
48 public:
49  /** Default constructor */
51  /** Set the input and output tensors.
52  *
53  * @param[in, out] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM],
54  * and an optional 4th dimension for batch of inputs. Data types supported: F16/F32 (Written to by the border handler).
55  * Data layouts supported: NCHW/NHWC.
56  * @param[out] output Destination tensor. Dimensions, data type and number of channels must match the input ones.
57  * Data types supported: same as @p input. Data layouts supported: same as @p input.
58  * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters.
59  */
60  void configure(ICLTensor *input, ICLTensor *output, const NormalizationLayerInfo &norm_info);
61  /** Static function to check if given info will lead to a valid configuration of @ref CLNormalizationLayer
62  *
63  * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM],
64  * and an optional 4th dimension for batch of inputs. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
65  * @param[in] output Destination tensor. Dimensions, data type and number of channels must match the input ones.
66  * Data layouts supported: same as @p input.
67  * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters.
68  *
69  * @return a status
70  */
71  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const NormalizationLayerInfo &norm_info);
72 
73  // Inherited methods overridden:
74  void run() override;
75 
76 private:
77  CLNormalizationLayerKernel _norm_kernel; /**< Normalization layer kernel to run */
78  CLFillBorderKernel _border_handler; /**< Kernel to handle borders */
79 };
80 }
81 #endif /* ARM_COMPUTE_CLNORMALIZATIONLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
Normalization Layer Information class.
Definition: Types.h:1677
Interface for the normalization layer kernel.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
void configure(ICLTensor *input, ICLTensor *output, const NormalizationLayerInfo &norm_info)
Set the input and output tensors.
Copyright (c) 2017-2020 ARM Limited.
void run() override
Run the kernels contained in the function.
Basic function to compute a normalization layer.
Interface for filling the border of a kernel.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const NormalizationLayerInfo &norm_info)
Static function to check if given info will lead to a valid configuration of CLNormalizationLayer.