xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/BatchNormalizationLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_GRAPH_BATCH_NORMALIZATION_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_BATCH_NORMALIZATION_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Batch Normalization Layer node */
34 class BatchNormalizationLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] epsilon          (Optional) Epsilon parameter. Defaults to 1.f
40      * @param[in] fused_activation (Optional) Fused activation layer. Disabled if not specified
41      */
42     BatchNormalizationLayerNode(float epsilon = 1.f, ActivationLayerInfo fused_activation = ActivationLayerInfo());
43     /** Epsilon parameter accessor
44      *
45      * @return Epsilon parameter
46      */
47     float epsilon() const;
48     /** Returns fused activation
49      *
50      * @return Fused activation
51      */
52     ActivationLayerInfo fused_activation() const;
53     /** Sets fused activation
54      *
55      * @param[in] fused_activation Fused activation to set
56      */
57     void set_fused_activation(ActivationLayerInfo fused_activation);
58 
59     // Inherited overridden methods:
60     NodeType         type() const override;
61     bool             forward_descriptors() override;
62     TensorDescriptor configure_output(size_t idx) const override;
63     void accept(INodeVisitor &v) override;
64 
65 public:
66     static constexpr NodeType node_type = NodeType::BatchNormalizationLayer;
67 
68 private:
69     float               _epsilon;
70     ActivationLayerInfo _fused_activation;
71 };
72 } // namespace graph
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_GRAPH_BATCH_NORMALIZATION_LAYER_NODE_H */
75