Node interface. More...

#include <INode.h>

Public Member Functions
	INode ()
	Constructor. More...

virtual	~INode ()=default
	Destructor. More...

	INode (const INode &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...

INode &	operator= (const INode &)=delete
	Prevent instances of this class from being copy assigned (As this class contains pointers) More...

	INode (INode &&)=default
	Allow instances of this class to be moved. More...

INode &	operator= (INode &&)=default
	Allow instances of this class to be move assigned. More...

virtual Status	validate () const
	Validate node. More...

virtual NodeType	type () const =0
	Returns node's type. More...

virtual void	accept (INodeVisitor &v)=0
	Accepts a node visitor. More...

virtual bool	forward_descriptors ()=0
	Forwards descriptor information to outputs if possible. More...

virtual TensorDescriptor	configure_output (size_t idx) const =0
	Calculates output configuration. More...

std::string	name () const
	Returns node's name. More...

NodeID	id () const
	Returns node's ID. More...

const Graph *	graph () const
	Returns node's Graph. More...

Graph *	graph ()
	Returns node's Graph. More...

void	set_graph (Graph *g)
	Sets the graph that this node is registered to. More...

void	set_id (NodeID id)
	Sets the node id. More...

void	set_common_node_parameters (NodeParams common_params)
	Sets common node parameters. More...

void	set_requested_target (Target target)
	Sets target preference. More...

void	set_assigned_target (Target target)
	Sets the final execution target. More...

void	set_output_tensor (TensorID tid, size_t idx)
	Sets the output tensor of at a given index. More...

const std::vector< TensorID > &	inputs () const
	Returns inputs of the node. More...

const std::vector< TensorID > &	outputs () const
	Returns outputs of the node. More...

const std::vector< EdgeID > &	input_edges () const
	Returns input edge set. More...

const std::set< EdgeID > &	output_edges () const
	Returns output edge set. More...

TensorID	input_id (size_t idx) const
	Returns the tensor ID of a given input of the node. More...

TensorID	output_id (size_t idx) const
	Returns the tensor ID of a given output of the node. More...

Tensor *	input (size_t idx) const
	Returns the tensor of a given input of the node. More...

Tensor *	output (size_t idx) const
	Returns the tensor of a given output of the node. More...

EdgeID	input_edge_id (size_t idx) const
	Returns the edge ID of a given input of the node. More...

Edge *	input_edge (size_t idx) const
	Returns the edge of a given input of the node. More...

size_t	num_inputs () const
	Returns number of inputs of the node. More...

size_t	num_outputs () const
	Returns number of outputs of the node. More...

NodeParams	common_node_params () const
	Returns common node parameters. More...

Target	requested_target () const
	Returns requested target for this node. More...

Target	assigned_target () const
	Returns assigned target for this node. More...

const std::list< std::unique_ptr< ConvPostOpInfo > > &	post_op_info_list () const
	Post operator info list. More...

std::list< std::unique_ptr< ConvPostOpInfo > > &	post_op_info_list ()
	Post operator info list. More...

Friends
class	Graph

Detailed Description

Node interface.

Definition at line 46 of file INode.h.

Constructor & Destructor Documentation

◆ INode() [1/3]

INode ( )

Constructor.

Definition at line 37 of file INode.cpp.

     : _graph(nullptr), _id(EmptyNodeID), _common_params({ "", Target::UNSPECIFIED}),
       _outputs(), _input_edges(), _output_edges(), _assigned_target(Target::UNSPECIFIED)
       ,_post_op_info_list(std::list<std::unique_ptr<ConvPostOpInfo>> {})
 {
 }

References arm_compute::graph::UNSPECIFIED.

◆ ~INode()

virtual ~INode ( )

virtualdefault

Destructor.

◆ INode() [2/3]

INode ( const INode & )

delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ INode() [3/3]

INode ( INode && )

default

Allow instances of this class to be moved.

Member Function Documentation

◆ accept()

virtual void accept ( INodeVisitor & v )

pure virtual

Accepts a node visitor.

Parameters

[in] v Visitor to accept

Implemented in FusedConvolutionBatchNormalizationNode, FusedDepthwiseConvolutionBatchNormalizationNode, FusedConvolutionWithPostOpNode, UnaryEltwiseLayerNode, ConvolutionLayerNode, FusedConvolutionBatchNormalizationWithPostOpsNode, DepthwiseConvolutionLayerNode, FullyConnectedLayerNode, StridedSliceLayerNode, EltwiseLayerNode, ConcatenateLayerNode, SplitLayerNode, L2NormalizeLayerNode, PrintLayerNode, SliceLayerNode, ArgMinMaxLayerNode, DeconvolutionLayerNode, BatchNormalizationLayerNode, StackLayerNode, DetectionOutputLayerNode, PoolingLayerNode, PriorBoxLayerNode, ReorgLayerNode, DepthToSpaceLayerNode, PadLayerNode, ReductionLayerNode, ROIAlignLayerNode, ActivationLayerNode, DummyNode, PermuteLayerNode, QuantizationLayerNode, ResizeLayerNode, BoundingBoxTransformLayerNode, GenerateProposalsLayerNode, ChannelShuffleLayerNode, DetectionPostProcessLayerNode, NormalizationLayerNode, SoftmaxLayerNode, DequantizationLayerNode, ConstNode, InputNode, ReshapeLayerNode, FlattenLayerNode, NormalizePlanarYUVLayerNode, OutputNode, and PReluLayerNode.

◆ assigned_target()

Target assigned_target ( ) const

Returns assigned target for this node.

Returns: Assigned target of this node

Definition at line 199 of file INode.cpp.

 {
     return _assigned_target;
 }

Referenced by arm_compute::graph::detail::configure_all_nodes(), NEDeviceBackend::configure_node(), CLDeviceBackend::configure_node(), GroupedConvolutionMutator::mutate(), NEDeviceBackend::validate_node(), CLDeviceBackend::validate_node(), and arm_compute::graph::backends::detail::validate_node().

◆ common_node_params()

NodeParams common_node_params ( ) const

Returns common node parameters.

Returns: Common node parameters

Definition at line 189 of file INode.cpp.

 {
     return _common_params;
 }

◆ configure_output()

virtual TensorDescriptor configure_output ( size_t idx ) const

pure virtual

Calculates output configuration.

Parameters

[in] idx Output index to configure

Returns: Output descriptor configuration

Implemented in FusedConvolutionBatchNormalizationNode, FusedDepthwiseConvolutionBatchNormalizationNode, FusedConvolutionWithPostOpNode, UnaryEltwiseLayerNode, ConvolutionLayerNode, FusedConvolutionBatchNormalizationWithPostOpsNode, DepthwiseConvolutionLayerNode, FullyConnectedLayerNode, StridedSliceLayerNode, EltwiseLayerNode, ConcatenateLayerNode, SplitLayerNode, L2NormalizeLayerNode, PrintLayerNode, SliceLayerNode, ArgMinMaxLayerNode, DeconvolutionLayerNode, BatchNormalizationLayerNode, StackLayerNode, DetectionOutputLayerNode, PoolingLayerNode, PriorBoxLayerNode, ReorgLayerNode, DepthToSpaceLayerNode, PadLayerNode, ReductionLayerNode, ROIAlignLayerNode, ActivationLayerNode, DummyNode, PermuteLayerNode, QuantizationLayerNode, ResizeLayerNode, BoundingBoxTransformLayerNode, GenerateProposalsLayerNode, ChannelShuffleLayerNode, DetectionPostProcessLayerNode, NormalizationLayerNode, SoftmaxLayerNode, DequantizationLayerNode, ConstNode, InputNode, ReshapeLayerNode, FlattenLayerNode, NormalizePlanarYUVLayerNode, OutputNode, and PReluLayerNode.

◆ forward_descriptors()

virtual bool forward_descriptors ( )

pure virtual

Forwards descriptor information to outputs if possible.

Returns: True if descriptor information could be forwarded otherwise false

Implemented in FusedConvolutionBatchNormalizationNode, FusedDepthwiseConvolutionBatchNormalizationNode, FusedConvolutionWithPostOpNode, UnaryEltwiseLayerNode, ConvolutionLayerNode, FusedConvolutionBatchNormalizationWithPostOpsNode, DepthwiseConvolutionLayerNode, FullyConnectedLayerNode, StridedSliceLayerNode, EltwiseLayerNode, ConcatenateLayerNode, SplitLayerNode, L2NormalizeLayerNode, PrintLayerNode, SliceLayerNode, ArgMinMaxLayerNode, DeconvolutionLayerNode, BatchNormalizationLayerNode, StackLayerNode, DetectionOutputLayerNode, PoolingLayerNode, PriorBoxLayerNode, ReorgLayerNode, DepthToSpaceLayerNode, PadLayerNode, ReductionLayerNode, ROIAlignLayerNode, ActivationLayerNode, DummyNode, PermuteLayerNode, QuantizationLayerNode, ResizeLayerNode, BoundingBoxTransformLayerNode, GenerateProposalsLayerNode, ChannelShuffleLayerNode, DetectionPostProcessLayerNode, NormalizationLayerNode, SoftmaxLayerNode, DequantizationLayerNode, ConstNode, InputNode, ReshapeLayerNode, FlattenLayerNode, NormalizePlanarYUVLayerNode, OutputNode, and PReluLayerNode.

Referenced by Graph::add_node().

◆ graph() [1/2]

Graph* graph ( )

Returns node's Graph.

Returns: Node's graph

◆ graph() [2/2]

Graph * graph ( ) const

Returns node's Graph.

Returns: Node's graph

Definition at line 113 of file INode.cpp.

 {
     return _graph;
 }

Referenced by arm_compute::graph::detail::all_inputs_are_visited(), arm_compute::graph::get_driver_nodes(), and arm_compute::graph::get_driving_nodes().

◆ id()

NodeID id ( ) const

Returns node's ID.

Returns: Node's ID

Definition at line 103 of file INode.cpp.

 {
     return _id;
 }

◆ input()

Tensor * input ( size_t idx ) const

Returns the tensor of a given input of the node.

Note: Precondition : idx should be a valid input index

Parameters

[in] idx Index of the node input

Returns: Tensor of the requested input

Definition at line 151 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(_graph == nullptr);
     ARM_COMPUTE_ERROR_ON(idx >= _input_edges.size());
     Edge *e = _graph->edge(_input_edges[idx]);
     return (e != nullptr) ? e->tensor() : nullptr;
 }

References ARM_COMPUTE_ERROR_ON, Graph::edge(), and Edge::tensor().

◆ input_edge()

Edge * input_edge ( size_t idx ) const

Returns the edge of a given input of the node.

Note: Precondition : idx should be a valid input index

Parameters

[in] idx Index of the node input

Returns: Edge of the requested input

Definition at line 172 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(_graph == nullptr);
     ARM_COMPUTE_ERROR_ON(idx >= _input_edges.size());
     return _graph->edge(_input_edges[idx]);
 }

References ARM_COMPUTE_ERROR_ON, and Graph::edge().

Referenced by arm_compute::graph::detail::fuse_convolution_with_batch_normalization(), and arm_compute::graph::detail::fuse_depthwise_convolution_with_batch_normalization().

◆ input_edge_id()

EdgeID input_edge_id ( size_t idx ) const

Returns the edge ID of a given input of the node.

Note: Precondition : idx should be a valid input index

Parameters

[in] idx Index of the node input

Returns: EdgeID of the requested input

Definition at line 166 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(idx >= _input_edges.size());
     return _input_edges[idx];
 }

References ARM_COMPUTE_ERROR_ON.

◆ input_edges()

const std::vector< EdgeID > & input_edges ( ) const

Returns input edge set.

Returns: Set of input edges

Definition at line 128 of file INode.cpp.

 {
     return _input_edges;
 }

Referenced by arm_compute::graph::detail::all_inputs_are_visited(), arm_compute::graph::get_driver_nodes(), and DepthConcatSubTensorMutator::mutate().

◆ input_id()

TensorID input_id ( size_t idx ) const

Returns the tensor ID of a given input of the node.

Note: Precondition : idx should be a valid input index

Parameters

[in] idx Index of the node input

Returns: TensorID of the requested input

Definition at line 138 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(idx >= _input_edges.size());
     Edge *e = _graph->edge(_input_edges[idx]);
     return (e != nullptr) ? e->tensor_id() : NullTensorID;
 }

References ARM_COMPUTE_ERROR_ON, Graph::edge(), arm_compute::graph::NullTensorID, and Edge::tensor_id().

◆ inputs()

const std::vector<TensorID>& inputs ( ) const

Returns inputs of the node.

Returns: Inputs of the node

◆ name()

std::string name ( ) const

Returns node's name.

Returns: Node name

Definition at line 108 of file INode.cpp.

 {
     return _common_params.name;
 }

References NodeParams::name.

◆ num_inputs()

size_t num_inputs ( ) const

Returns number of inputs of the node.

Returns: Number of inputs

Definition at line 179 of file INode.cpp.

 {
     return _input_edges.size();
 }

◆ num_outputs()

size_t num_outputs ( ) const

Returns number of outputs of the node.

Returns: Number of outputs

Definition at line 184 of file INode.cpp.

 {
     return _outputs.size();
 }

◆ operator=() [1/2]

INode& operator= ( const INode & )

delete

Prevent instances of this class from being copy assigned (As this class contains pointers)

◆ operator=() [2/2]

INode& operator= ( INode && )

default

Allow instances of this class to be move assigned.

◆ output()

Tensor * output ( size_t idx ) const

Returns the tensor of a given output of the node.

Note: Precondition : idx should be a valid output index

Parameters

[in] idx Index of the node output

Returns: Tensor of the requested output

Definition at line 159 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(_graph == nullptr);
     ARM_COMPUTE_ERROR_ON(idx >= _outputs.size());
     return _graph->tensor(_outputs[idx]);
 }

References ARM_COMPUTE_ERROR_ON, and Graph::tensor().

◆ output_edges()

const std::set< EdgeID > & output_edges ( ) const

Returns output edge set.

Returns: Set of output edges

Definition at line 133 of file INode.cpp.

 {
     return _output_edges;
 }

Referenced by arm_compute::graph::bfs(), arm_compute::graph::dfs(), arm_compute::graph::detail::fuse_layer(), arm_compute::graph::get_driving_nodes(), arm_compute::graph::detail::get_post_op_list(), and Graph::remove_node().

◆ output_id()

TensorID output_id ( size_t idx ) const

Returns the tensor ID of a given output of the node.

Note: Precondition : idx should be a valid output index

Parameters

[in] idx Index of the node output

Returns: TensorID of the requested output

Definition at line 145 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(idx >= _outputs.size());
     return _outputs[idx];
 }

References ARM_COMPUTE_ERROR_ON.

◆ outputs()

const std::vector< TensorID > & outputs ( ) const

Returns outputs of the node.

Returns: Outputs of the node

Definition at line 123 of file INode.cpp.

 {
     return _outputs;
 }

Referenced by GraphBuilder::add_batch_normalization_node(), GraphBuilder::add_convolution_node(), GraphBuilder::add_deconvolution_node(), GraphBuilder::add_depthwise_convolution_node(), GraphBuilder::add_detection_post_process_node(), GraphBuilder::add_fully_connected_layer(), GraphBuilder::add_normalize_planar_yuv_node(), GraphBuilder::add_scale_layer(), GraphBuilder::add_yolo_node(), and SplitLayerSubTensorMutator::mutate().

◆ post_op_info_list() [1/2]

std::list<std::unique_ptr<ConvPostOpInfo> >& post_op_info_list ( )

Post operator info list.

Returns: Post operator info list

◆ post_op_info_list() [2/2]

std::list< std::unique_ptr< ConvPostOpInfo > > & post_op_info_list ( ) const

Post operator info list.

Returns: Post operator info list

Definition at line 204 of file INode.cpp.

 {
     return _post_op_info_list;
 }

Referenced by arm_compute::graph::backends::detail::create_fused_convolution_batch_normalization_with_post_op(), arm_compute::graph::backends::detail::create_fused_convolution_with_post_op(), and arm_compute::graph::detail::fuse_convolution_with_post_op().

◆ requested_target()

Target requested_target ( ) const

Returns requested target for this node.

Returns: Requested execution target

Definition at line 194 of file INode.cpp.

 {
     return _common_params.target;
 }

References NodeParams::target.

◆ set_assigned_target()

void set_assigned_target ( Target target )

Sets the final execution target.

Note: GraphManager might change this target

Parameters

[in] target Final execution target

Definition at line 72 of file INode.cpp.

 {
     _assigned_target = target;
 }

Referenced by arm_compute::graph::detail::fuse_convolution_batch_normalization_with_post_ops(), and arm_compute::graph::detail::fuse_convolution_with_post_ops().

◆ set_common_node_parameters()

void set_common_node_parameters ( NodeParams common_params )

Sets common node parameters.

Parameters

[in] common_params Common node parameters to set

Definition at line 62 of file INode.cpp.

 {
     _common_params = std::move(common_params);
 }

Referenced by GraphEdsr::setup().

◆ set_graph()

void set_graph ( Graph * g )

Sets the graph that this node is registered to.

Parameters

[in] g Back reference to graph

Definition at line 51 of file INode.cpp.

 {
     ARM_COMPUTE_ERROR_ON(g == nullptr);
     _graph = g;
 }

References ARM_COMPUTE_ERROR_ON.

Referenced by Graph::add_node().

◆ set_id()

void set_id ( NodeID id )

Sets the node id.

Parameters

[in] id Node id

Definition at line 57 of file INode.cpp.

 {
     _id = id;
 }

References INode::id().

Referenced by Graph::add_node().

◆ set_output_tensor()

void set_output_tensor	(	TensorID	tid,
		size_t	idx
	)

Sets the output tensor of at a given index.

Note: All edges will get updated

Parameters

[in]	tid	Tensor ID
[in]	idx	Output index

Definition at line 77 of file INode.cpp.

 {
     if(tid != NullTensorID && (idx < _outputs.size()) && (_graph->tensor(tid) != nullptr))
     {
         ARM_COMPUTE_ERROR_ON(_graph == nullptr);
         Tensor *updated_tensor = _graph->tensor(tid);
         _outputs[idx]          = tid;
  
         // Set tensor to all output edges of the node
         for(auto &output_edge_id : _output_edges)
         {
             auto output_edge = _graph->edge(output_edge_id);
             if(output_edge != nullptr)
             {
                 // Unbind edge from current tensor
                 auto current_output_tensor = output_edge->tensor();
                 current_output_tensor->unbind_edge(output_edge->id());
  
                 // Update tensor to edge and rebind tensor
                 output_edge->update_bound_tensor(updated_tensor);
                 updated_tensor->bind_edge(output_edge->id());
             }
         }
     }
 }

References ARM_COMPUTE_ERROR_ON, Tensor::bind_edge(), Graph::edge(), arm_compute::graph::NullTensorID, Edge::tensor(), Graph::tensor(), and Tensor::unbind_edge().

◆ set_requested_target()

void set_requested_target ( Target target )

Sets target preference.

Note: This is not the target that the graph executor might choose, its just an indication

Parameters

[in] target Target preference

Definition at line 67 of file INode.cpp.

 {
     _common_params.target = target;
 }

References NodeParams::target.

◆ type()

virtual NodeType type ( ) const

pure virtual

Returns node's type.

Returns: Node's type

Implemented in FusedConvolutionBatchNormalizationNode, FusedDepthwiseConvolutionBatchNormalizationNode, FusedConvolutionWithPostOpNode, UnaryEltwiseLayerNode, ConvolutionLayerNode, FusedConvolutionBatchNormalizationWithPostOpsNode, DepthwiseConvolutionLayerNode, FullyConnectedLayerNode, StridedSliceLayerNode, EltwiseLayerNode, ConcatenateLayerNode, SplitLayerNode, L2NormalizeLayerNode, PrintLayerNode, SliceLayerNode, ArgMinMaxLayerNode, DeconvolutionLayerNode, BatchNormalizationLayerNode, StackLayerNode, DetectionOutputLayerNode, PoolingLayerNode, PriorBoxLayerNode, ReorgLayerNode, DepthToSpaceLayerNode, PadLayerNode, ReductionLayerNode, ROIAlignLayerNode, ActivationLayerNode, DummyNode, PermuteLayerNode, QuantizationLayerNode, ResizeLayerNode, BoundingBoxTransformLayerNode, GenerateProposalsLayerNode, ChannelShuffleLayerNode, DetectionPostProcessLayerNode, NormalizationLayerNode, SoftmaxLayerNode, DequantizationLayerNode, ConstNode, InputNode, ReshapeLayerNode, FlattenLayerNode, NormalizePlanarYUVLayerNode, OutputNode, and PReluLayerNode.

Referenced by Graph::add_node(), CLFunctionFactory::create(), NEFunctionFactory::create(), arm_compute::graph::execute_task(), arm_compute::graph::is_utility_node(), DepthConcatSubTensorMutator::mutate(), GroupedConvolutionMutator::mutate(), SplitLayerSubTensorMutator::mutate(), Graph::remove_node(), NENodeValidator::validate(), CLNodeValidator::validate(), and arm_compute::graph::backends::detail::validate_node().

◆ validate()

Status validate ( ) const

virtual

Validate node.

Returns: Status containing any errors

Reimplemented in SplitLayerNode.

Definition at line 46 of file INode.cpp.

 {
     return Status{};
 }

Friends And Related Function Documentation

◆ Graph

friend class Graph

friend

Definition at line 256 of file INode.h.

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

arm_compute/graph/INode.h
src/graph/INode.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ INode() [1/3]

◆ ~INode()

◆ INode() [2/3]

◆ INode() [3/3]

Member Function Documentation

◆ accept()

◆ assigned_target()

◆ common_node_params()

◆ configure_output()

◆ forward_descriptors()

◆ graph() [1/2]

◆ graph() [2/2]

◆ id()

◆ input()

◆ input_edge()

◆ input_edge_id()

◆ input_edges()

◆ input_id()

◆ inputs()

◆ name()

◆ num_inputs()

◆ num_outputs()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ output()

◆ output_edges()

◆ output_id()

◆ outputs()

◆ post_op_info_list() [1/2]

◆ post_op_info_list() [2/2]

◆ requested_target()

◆ set_assigned_target()

◆ set_common_node_parameters()

◆ set_graph()

◆ set_id()

◆ set_output_tensor()

◆ set_requested_target()

◆ type()

◆ validate()

Friends And Related Function Documentation

◆ Graph