aboutsummaryrefslogtreecommitdiff
path: root/src/armnn/layers/MultiplicationLayer.hpp
diff options
context:
space:
mode:
authorConor Kennedy <conor.kennedy@arm.com>2018-12-21 14:38:36 +0000
committerLes Bell <les.bell@arm.com>2018-12-24 09:33:39 +0000
commit35052ae3f44d24cd71f437a2011c5032d34c94a7 (patch)
tree21cdc0f077606f80713f75c6eaeace2adcd4bb20 /src/armnn/layers/MultiplicationLayer.hpp
parenta06bf31afabfb84e60740ea3219406ab13c8e6a6 (diff)
downloadarmnn-35052ae3f44d24cd71f437a2011c5032d34c94a7.tar.gz
IVGCVSW-59 Add documentation to the public API
* Add documentation to the Descriptors * Add documentation to the layers Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9
Diffstat (limited to 'src/armnn/layers/MultiplicationLayer.hpp')
-rw-r--r--src/armnn/layers/MultiplicationLayer.hpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/armnn/layers/MultiplicationLayer.hpp b/src/armnn/layers/MultiplicationLayer.hpp
index 8a7bfdea39..9f15e3a4c6 100644
--- a/src/armnn/layers/MultiplicationLayer.hpp
+++ b/src/armnn/layers/MultiplicationLayer.hpp
@@ -10,16 +10,27 @@
namespace armnn
{
+/// This layer represents a multiplication operation.
class MultiplicationLayer : public ElementwiseBaseLayer
{
public:
+ /// Makes a workload for the Multiplication type.
+ /// @param [in] graph The graph where this layer can be found.
+ /// @param [in] factory The workload factory which will create the workload.
+ /// @return A pointer to the created workload, or nullptr if not created.
virtual std::unique_ptr<IWorkload> CreateWorkload(const Graph& graph,
const IWorkloadFactory& factory) const override;
+ /// Creates a dynamically-allocated copy of this layer.
+ /// @param [in] graph The graph into which this layer is being cloned.
MultiplicationLayer* Clone(Graph& graph) const override;
protected:
+ /// Constructor to create a MultiplicationLayer.
+ /// @param [in] name Optional name for the layer
MultiplicationLayer(const char* name);
+
+ /// Default destructor
~MultiplicationLayer() = default;
};