Compute Library
 21.05
SoftmaxLayerNode.h
Go to the documentation of this file.
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_SOFTMAX_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_SOFTMAX_LAYER_NODE_H
26 
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Softmax Layer node */
34 class SoftmaxLayerNode final : public INode
35 {
36 public:
37  /** Constructor
38  *
39  * @param[in] beta (Optional) Beta parameter. Defaults to 1
40  */
41  SoftmaxLayerNode(float beta = 1.f);
42  /** Beta parameter accessor
43  *
44  * @return Beta parameter
45  */
46  float beta() const;
47 
48  // Inherited overridden methods:
49  NodeType type() const override;
50  bool forward_descriptors() override;
51  TensorDescriptor configure_output(size_t idx) const override;
52  void accept(INodeVisitor &v) override;
53 
54 public:
56 
57 private:
58  float _beta;
59 };
60 } // namespace graph
61 } // namespace arm_compute
62 #endif /* ARM_COMPUTE_GRAPH_SOFTMAX_LAYER_NODE_H */
NodeType type() const override
Returns node's type.
TensorDescriptor configure_output(size_t idx) const override
Calculates output configuration.
SoftmaxLayerNode(float beta=1.f)
Constructor.
static constexpr NodeType node_type
Copyright (c) 2017-2021 Arm Limited.
Node interface.
Definition: INode.h:45
bool forward_descriptors() override
Forwards descriptor information to outputs if possible.
float beta() const
Beta parameter accessor.
NodeType
Supported nodes.
Definition: Types.h:148
void accept(INodeVisitor &v) override
Accepts a node visitor.
Node visitor interface.
Definition: INodeVisitor.h:34