ArmNN
 20.02
ConstantLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include <Layer.hpp>
8 
9 namespace armnn
10 {
11 
12 class ScopedCpuTensorHandle;
13 
14 /// A layer that the constant data can be bound to.
15 class ConstantLayer : public Layer
16 {
17 public:
18  /// Makes a workload for the Constant type.
19  /// @param [in] graph The graph where this layer can be found.
20  /// @param [in] factory The workload factory which will create the workload.
21  /// @return A pointer to the created workload, or nullptr if not created.
22  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
23 
24  /// Creates a dynamically-allocated copy of this layer.
25  /// @param [in] graph The graph into which this layer is being cloned.
26  ConstantLayer* Clone(Graph& graph) const override;
27 
28  /// Check if the input tensor shape(s)
29  /// will lead to a valid configuration of @ref ConstantLayer
30  void ValidateTensorShapesFromInputs() override;
31 
32  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
33  /// otherwise infers the output shapes from given input shapes and layer properties.
34  /// @param [in] inputShapes The input shapes layer has.
35  /// @return a vector to the inferred output shape.
36  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
37 
38  /// Free up the constant source data stored by the layer.
39  void ReleaseConstantData() override {}
40 
41  void Accept(ILayerVisitor& visitor) const override;
42 
43  std::unique_ptr<ScopedCpuTensorHandle> m_LayerOutput;
44 
45 protected:
46  /// Constructor to create a ConstantLayer.
47  /// @param [in] name Optional name for the layer.
48  ConstantLayer(const char* name);
49 
50  /// Default destructor
51  ~ConstantLayer() = default;
52 
53  /// Retrieve the handles to the constant values stored by the layer.
54  ConstantTensors GetConstantTensorsByRef() override { return {m_LayerOutput}; }
55 };
56 
57 } // namespace
A layer that the constant data can be bound to.
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Constant type.
void Accept(ILayerVisitor &visitor) const override
Apply a visitor to this layer.
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ConstantLayer.
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties.
Copyright (c) 2020 ARM Limited.
std::unique_ptr< ScopedCpuTensorHandle > m_LayerOutput
~ConstantLayer()=default
Default destructor.
ConstantLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
void ReleaseConstantData() override
Free up the constant source data stored by the layer.
ConstantTensors GetConstantTensorsByRef() override
Retrieve the handles to the constant values stored by the layer.
ConstantLayer(const char *name)
Constructor to create a ConstantLayer.
std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >> ConstantTensors
Definition: Layer.hpp:363