arm_compute v18.05
[platform/upstream/armcl.git] / arm_compute / graph / nodes / EltwiseLayerNode.h
1 /*
2  * Copyright (c) 2018 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_ELTWISE_LAYER_NODE_H__
25 #define __ARM_COMPUTE_GRAPH_ELTWISE_LAYER_NODE_H__
26
27 #include "arm_compute/graph/INode.h"
28
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Eltwise Layer node */
34 class EltwiseLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] op       Element-wise operation to perform
40      * @param[in] c_policy (Optional) Convert policy used for the operation
41      * @param[in] r_policy (Optional) Rounding policy used for the operation
42      */
43     EltwiseLayerNode(EltwiseOperation op, ConvertPolicy c_policy = ConvertPolicy::SATURATE, RoundingPolicy r_policy = RoundingPolicy::TO_ZERO);
44     /** Eltwise operation accessor
45      *
46      * @return Eltwise operation that is to be performed by the node
47      */
48     EltwiseOperation eltwise_operation() const;
49
50     /** Convert policy accessor
51      *
52      * @return Convert policy that is used in the node
53      */
54     ConvertPolicy convert_policy() const;
55
56     /** Rounding policy accessor
57      *
58      * @return Convert policy that is used in the node
59      */
60     RoundingPolicy rounding_policy() const;
61
62     // Inherited overridden methods:
63     NodeType         type() const override;
64     bool             forward_descriptors() override;
65     TensorDescriptor configure_output(size_t idx) const override;
66     void accept(INodeVisitor &v) override;
67
68 private:
69     EltwiseOperation _op;
70     ConvertPolicy    _convert_policy;
71     RoundingPolicy   _rounding_policy;
72 };
73 } // namespace graph
74 } // namespace arm_compute
75 #endif /* __ARM_COMPUTE_GRAPH_ELTWISE_LAYER_NODE_H__ */