arm_compute v17.10
[platform/upstream/armcl.git] / arm_compute / graph / nodes / L2NormalizeLayer.h
1 /*
2  * Copyright (c) 2017 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_L2NORMALIZE_LAYER_H__
25 #define __ARM_COMPUTE_GRAPH_L2NORMALIZE_LAYER_H__
26
27 #include "arm_compute/graph/GraphContext.h"
28 #include "arm_compute/graph/INode.h"
29 #include "arm_compute/graph/Tensor.h"
30 #include "arm_compute/graph/Types.h"
31
32 namespace arm_compute
33 {
34 namespace graph
35 {
36 /** L2Normalize layer node */
37 class L2NormalizeLayer final : public INode
38 {
39 public:
40     /** Default Constructor
41      *
42      * @param[in] axis    Dimension along which to reduce.
43      * @param[in] epsilon Lower bound value for the normalization.
44      */
45     explicit L2NormalizeLayer(unsigned int axis, float epsilon)
46         : _axis(axis), _epsilon(epsilon)
47     {
48     }
49
50     // Inherited methods overriden:
51     std::unique_ptr<arm_compute::IFunction> instantiate_node(GraphContext &ctx, ITensor *input, ITensor *output) override;
52
53 private:
54     unsigned int _axis;
55     float        _epsilon;
56 };
57 } // namespace graph
58 } // namespace arm_compute
59 #endif /* __ARM_COMPUTE_GRAPH_L2NORMALIZE_LAYER_H__ */