ArmNN
 20.05
ElementwiseBaseLayer Class Reference

NOTE: this is an abstract class to encapsulate the element wise operations, it does not implement: std::unique_ptr<IWorkload> Layer::CreateWorkload(const IWorkloadFactory& factory) const = 0; Layer* Clone(Graph& graph) const = 0;. More...

#include <ElementwiseBaseLayer.hpp>

Inheritance diagram for ElementwiseBaseLayer:
Layer IConnectableLayer AdditionLayer DivisionLayer MaximumLayer MinimumLayer MultiplicationLayer SubtractionLayer

Public Member Functions

void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s) will lead to a valid configuration of the element wise operation. More...
 
std::vector< TensorShapeInferOutputShapes (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. More...
 
- Public Member Functions inherited from Layer
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
 
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, DataLayout layout, const char *name)
 
const std::string & GetNameStr () const
 
const OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (unsigned int i=0)
 
const std::vector< InputSlot > & GetInputSlots () const
 
const std::vector< OutputSlot > & GetOutputSlots () const
 
std::vector< InputSlot >::iterator BeginInputSlots ()
 
std::vector< InputSlot >::iterator EndInputSlots ()
 
std::vector< OutputSlot >::iterator BeginOutputSlots ()
 
std::vector< OutputSlot >::iterator EndOutputSlots ()
 
bool IsOutputUnconnected ()
 
void ResetPriority () const
 
LayerPriority GetPriority () const
 
LayerType GetType () const
 
DataType GetDataType () const
 
const BackendIdGetBackendId () const
 
void SetBackendId (const BackendId &id)
 
virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const =0
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
virtual LayerClone (Graph &graph) const =0
 Creates a dynamically-allocated copy of this layer. More...
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
virtual void SerializeLayerParameters (ParameterStringifyFunction &fn) const
 Helper to serialize the layer parameters to string. More...
 
virtual void ReleaseConstantData ()
 
template<typename Op >
void OperateOnConstantTensors (Op op)
 
const char * GetName () const override
 Returns the name of the layer. More...
 
unsigned int GetNumInputSlots () const override
 Returns the number of connectable input slots. More...
 
unsigned int GetNumOutputSlots () const override
 Returns the number of connectable output slots. More...
 
const InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (unsigned int index=0) override
 Get the output slot handle by slot index. More...
 
void SetGuid (LayerGuid guid)
 
LayerGuid GetGuid () const final
 Returns the unique id of the layer. More...
 
void AddRelatedLayerName (const std::string layerName)
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0
 
void BackendSelectionHint (Optional< BackendId > backend) final
 Provide a hint for the optimizer as to which backend to prefer for this layer. More...
 
Optional< BackendIdGetBackendHint () const
 
- Public Member Functions inherited from IConnectableLayer
virtual void Accept (ILayerVisitor &visitor) const =0
 Apply a visitor to this layer. More...
 

Protected Member Functions

 ElementwiseBaseLayer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
 
 ~ElementwiseBaseLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from Layer
virtual ~Layer ()=default
 
template<typename QueueDescriptor >
void CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
void CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef ()
 
- Protected Member Functions inherited from IConnectableLayer
 ~IConnectableLayer ()
 Objects are not deletable via the handle. More...
 

Additional Inherited Members

- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from Layer
std::vector< OutputHandlerm_OutputHandlers
 

Detailed Description

NOTE: this is an abstract class to encapsulate the element wise operations, it does not implement: std::unique_ptr<IWorkload> Layer::CreateWorkload(const IWorkloadFactory& factory) const = 0; Layer* Clone(Graph& graph) const = 0;.

Definition at line 16 of file ElementwiseBaseLayer.hpp.

Constructor & Destructor Documentation

◆ ElementwiseBaseLayer()

ElementwiseBaseLayer ( unsigned int  numInputSlots,
unsigned int  numOutputSlots,
LayerType  type,
const char *  name 
)
protected
Parameters
numInputSlotsThe number of input slots for the layer.
numOutputSlotsThe number of output slots for the layer.
typeThe layer type.
nameOptional name for the layer.

Definition at line 16 of file ElementwiseBaseLayer.cpp.

18  : Layer(numInputSlots, numOutputSlots, type, name)
19 {
20 }
Layer(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
Definition: Layer.cpp:214

◆ ~ElementwiseBaseLayer()

~ElementwiseBaseLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ InferOutputShapes()

std::vector< TensorShape > InferOutputShapes ( const std::vector< TensorShape > &  inputShapes) const
overridevirtual

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.

Parameters
[in]inputShapesThe input shapes layer has.
Returns
A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 22 of file ElementwiseBaseLayer.cpp.

References ARMNN_ASSERT, and ARMNN_ASSERT_MSG.

Referenced by ElementwiseBaseLayer::ValidateTensorShapesFromInputs().

23 {
24  ARMNN_ASSERT(inputShapes.size() == 2);
25  auto& input0 = inputShapes[0];
26  auto& input1 = inputShapes[1];
27 
28  // Get the max of the inputs.
29  ARMNN_ASSERT(input0.GetNumDimensions() == input1.GetNumDimensions());
30  unsigned int numDims = input0.GetNumDimensions();
31  std::vector<unsigned int> dims(numDims);
32 
33  for (unsigned int i = 0; i < numDims; i++)
34  {
35  unsigned int dim0 = input0[i];
36  unsigned int dim1 = input1[i];
37 
38 #if !NDEBUG
39  // Validate inputs are broadcast compatible.
40  ARMNN_ASSERT_MSG(dim0 == dim1 || dim0 == 1 || dim1 == 1,
41  "Dimensions should either match or one should be of size 1.");
42 #endif
43 
44  dims[i] = std::max(dim0, dim1);
45  }
46 
47  return std::vector<TensorShape>({ TensorShape(numDims, dims.data()) });
48 }
#define ARMNN_ASSERT_MSG(COND, MSG)
Definition: Assert.hpp:15
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

Check if the input tensor shape(s) will lead to a valid configuration of the element wise operation.

Implements Layer.

Definition at line 50 of file ElementwiseBaseLayer.cpp.

References ARMNN_ASSERT, CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), armnn::GetLayerTypeAsCString(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), Layer::GetType(), ElementwiseBaseLayer::InferOutputShapes(), and Layer::VerifyLayerConnections().

51 {
53 
54  auto inferredShapes = InferOutputShapes({
57  });
58 
59  ARMNN_ASSERT(inferredShapes.size() == 1);
60 
61  std::string msg = GetLayerTypeAsCString(GetType());
62  msg += "Layer: TensorShape set on OutputSlot[0] does not match the inferred shape.";
63  ConditionalThrowIfNotEqual<LayerValidationException>(msg,
65  inferredShapes[0]);
66 }
const TensorShape & GetShape() const
Definition: Tensor.hpp:88
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.
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:339
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:310
char const * GetLayerTypeAsCString(LayerType type)
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
#define CHECK_LOCATION()
Definition: Exceptions.hpp:192
LayerType GetType() const
Definition: Layer.hpp:259
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:312
virtual const TensorInfo & GetTensorInfo() const =0
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63

The documentation for this class was generated from the following files: