From 03c7ff3f6188240baaeaeb405a357a0c58195fec Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Tue, 22 Aug 2023 12:00:04 +0100 Subject: IVGCVSW-7702 Update Doxygen Docu for 23.08 Signed-off-by: Nikhil Raj Change-Id: I357a9f7e47614589327c1ac5d95b6224ff77103d --- 23.08/_constant_layer_8hpp_source.html | 192 +++++++++++++++++++++++++++++++++ 1 file changed, 192 insertions(+) create mode 100644 23.08/_constant_layer_8hpp_source.html (limited to '23.08/_constant_layer_8hpp_source.html') diff --git a/23.08/_constant_layer_8hpp_source.html b/23.08/_constant_layer_8hpp_source.html new file mode 100644 index 0000000000..4f594a0fcf --- /dev/null +++ b/23.08/_constant_layer_8hpp_source.html @@ -0,0 +1,192 @@ + + + + + + + + +Arm NN: src/armnn/layers/ConstantLayer.hpp Source File + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.08 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
ConstantLayer.hpp
+
+
+Go to the documentation of this file.
1 //
+
2 // Copyright © 2017, 2023 Arm Ltd and Contributors. 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 ScopedTensorHandle;
+
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  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
+
31  void ValidateTensorShapesFromInputs() override;
+
32 
+
33  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
+
34  /// otherwise infers the output shapes from given input shapes and layer properties.
+
35  /// @param [in] inputShapes The input shapes layer has.
+
36  /// @return a vector to the inferred output shape.
+
37  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
+
38 
+
39  /// Free up the constant source data stored by the layer.
+
40  void ReleaseConstantData() override {}
+
41 
+
42  void ExecuteStrategy(IStrategy& strategy) const override;
+
43 
+
44  void SerializeLayerParameters(ParameterStringifyFunction &fn) const override;
+
45 
+
46  std::shared_ptr<ConstTensorHandle> m_LayerOutput;
+
47 
+
48 protected:
+
49  /// Constructor to create a ConstantLayer.
+
50  /// @param [in] name Optional name for the layer.
+
51  ConstantLayer(const char* name);
+
52 
+
53  /// Default destructor
+
54  ~ConstantLayer() = default;
+
55 
+
56  /// Retrieve the handles to the constant values stored by the layer.
+
57  // For API stability DO NOT ALTER order and add new members to the end of vector
+
58  ImmutableConstantTensors GetConstantTensorsByRef() const override { return {m_LayerOutput}; }
+
59 };
+
60 
+
61 } // namespace
+
+
+
armnn::ConstantLayer::InferOutputShapes
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,...
Definition: ConstantLayer.cpp:40
+
armnn::ConstantLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ConstantLayer.
Definition: ConstantLayer.cpp:45
+
armnn::ConstantLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: ConstantLayer.cpp:65
+
armnn::ConstantLayer::ConstantLayer
ConstantLayer(const char *name)
Constructor to create a ConstantLayer.
Definition: ConstantLayer.cpp:16
+ + +
armnn::IConnectableLayer::ImmutableConstantTensors
std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >> ImmutableConstantTensors
Definition: INetwork.hpp:141
+
armnn::ConstantLayer::~ConstantLayer
~ConstantLayer()=default
Default destructor.
+ +
armnn::ParameterStringifyFunction
std::function< void(const std::string &name, const std::string &value)> ParameterStringifyFunction
Definition: SerializeLayerParameters.hpp:14
+
armnn::ConstantLayer::Clone
ConstantLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: ConstantLayer.cpp:30
+
armnn::ConstantLayer::m_LayerOutput
std::shared_ptr< ConstTensorHandle > m_LayerOutput
Definition: ConstantLayer.hpp:46
+
armnn::ConstantLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Constant type.
Definition: ConstantLayer.cpp:21
+
armnn::ConstantLayer::GetConstantTensorsByRef
ImmutableConstantTensors GetConstantTensorsByRef() const override
Retrieve the handles to the constant values stored by the layer.
Definition: ConstantLayer.hpp:58
+
armnn::ConstantLayer::ReleaseConstantData
void ReleaseConstantData() override
Free up the constant source data stored by the layer.
Definition: ConstantLayer.hpp:40
+
armnn::ConstantLayer
A layer that the constant data can be bound to.
Definition: ConstantLayer.hpp:15
+
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
+ +
armnn::ConstantLayer::SerializeLayerParameters
void SerializeLayerParameters(ParameterStringifyFunction &fn) const override
Helper to serialize the layer parameters to string.
Definition: ConstantLayer.cpp:72
+ + + + + -- cgit v1.2.1