Compute Library
 22.05
CLNormalizationLayerKernel.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_CLNORMALIZATIONLAYERKERNEL_H
25 #define ARM_COMPUTE_CLNORMALIZATIONLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the normalization layer kernel.
34  */
36 {
37 public:
38  /** Constructor */
40  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  /** Prevent instances of this class from being copied (As this class contains pointers) */
44  /** Default Move Constructor. */
46  /** Default move assignment operator */
48  /** Set the input and output tensors.
49  *
50  * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM],
51  * and an optional 4th dimension for batch of inputs. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
52  * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data types supported: same as @p input.
53  * Data layouts supported: same as @p input.
54  * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters.
55  */
56  void configure(const ICLTensor *input, ICLTensor *output, NormalizationLayerInfo norm_info);
57  /** Set the input and output tensors.
58  *
59  * @param[in] compile_context The compile context to be used.
60  * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM],
61  * and an optional 4th dimension for batch of inputs. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
62  * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data types supported: same as @p input.
63  * Data layouts supported: same as @p input.
64  * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters.
65  */
66  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, NormalizationLayerInfo norm_info);
67  /** Static function to check if given info will lead to a valid configuration of @ref CLNormalizationLayerKernel
68  *
69  * @param[in] input Source tensor. 3 lower dims represent a single input with dimensions [width, height, IFM],
70  * and an optional 4th dimension for batch of inputs. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC.
71  * @param[in] output Destination tensor. Output will have the same number of dimensions as input. Data types supported: same as @p input.
72  * Data layouts supported: same as @p input.
73  * @param[in] norm_info Normalization layer information like the normalization type, normalization size and other parameters.
74  *
75  * @return a status
76  */
77  static Status validate(const ITensorInfo *input, const ITensorInfo *output, NormalizationLayerInfo norm_info);
78 
79  // Inherited methods overridden:
80  void run(const Window &window, cl::CommandQueue &queue) override;
81  BorderSize border_size() const override;
82 
83 private:
84  const ICLTensor *_input;
85  ICLTensor *_output;
86  BorderSize _border_size;
87  bool _is_norm_across_width;
88 };
89 } // namespace arm_compute
90 #endif /*ARM_COMPUTE_CLNORMALIZATIONLAYERKERNEL_H */
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
BorderSize border_size() const override
The size of the border for that kernel.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Container for 2D border size.
Definition: Types.h:282
Normalization Layer Information class.
Definition: Types.h:1726
Interface for the normalization layer kernel.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:81
Copyright (c) 2017-2022 Arm Limited.
void configure(const ICLTensor *input, ICLTensor *output, NormalizationLayerInfo norm_info)
Set the input and output tensors.
CLCompileContext class.
CLNormalizationLayerKernel & operator=(const CLNormalizationLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
static Status validate(const ITensorInfo *input, const ITensorInfo *output, NormalizationLayerInfo norm_info)
Static function to check if given info will lead to a valid configuration of CLNormalizationLayerKern...
Describe a multidimensional execution window.
Definition: Window.h:39