Split Layer node. More...

#include <SplitLayerNode.h>

Collaboration diagram for SplitLayerNode:

Public Member Functions
	SplitLayerNode (unsigned int num_splits, int axis=0, std::vector< int > size_splits=std::vector< int >())
	Default Constructor. More...

std::pair< TensorDescriptor, Coordinates >	compute_output_descriptor (const TensorDescriptor &input_descriptor, unsigned int num_splits, int axis, unsigned int idx)
	Computes split layer output descriptor. More...

unsigned int	num_splits () const
	Number of splits accessor. More...

unsigned int	axis () const
	Split axis accessor. More...

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

NodeType	type () const override
	Returns node's type. More...

bool	forward_descriptors () override
	Forwards descriptor information to outputs if possible. More...

TensorDescriptor	configure_output (size_t idx) const override
	Calculates output configuration. More...

void	accept (INodeVisitor &v) override
	Accepts a node visitor. More...

Public Member Functions inherited from INode
	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...

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...

Detailed Description

Split Layer node.

Definition at line 36 of file SplitLayerNode.h.

Constructor & Destructor Documentation

◆ SplitLayerNode()

SplitLayerNode	(	unsigned int	num_splits,
		int	axis = `0`,
		std::vector< int >	size_splits = `std::vector<int>()`
	)

Default Constructor.

Parameters

[in]	num_splits	Number of splits
[in]	axis	(Optional) Axis to split on. Defaults to 0
[in]	size_splits	(Optional) The sizes of each output tensor along the split dimension. Must sum to the dimension of value along split_dim. Can contain one -1 indicating that dimension is to be inferred.

Definition at line 35 of file SplitLayerNode.cpp.

     : _num_splits(num_splits), _axis(axis), _size_splits(size_splits)
 {
     _input_edges.resize(1, EmptyEdgeID);
     _outputs.resize(num_splits, NullTensorID);
 }

References arm_compute::graph::EmptyEdgeID, arm_compute::graph::NullTensorID, and SplitLayerNode::num_splits().

Member Function Documentation

◆ accept()

void accept ( INodeVisitor & v )

overridevirtual

Accepts a node visitor.

Parameters

[in] v Visitor to accept

Implements INode.

Definition at line 154 of file SplitLayerNode.cpp.

 {
     v.visit(*this);
 }

References INodeVisitor::visit().

◆ axis()

unsigned int axis ( ) const

Split axis accessor.

Returns: Split axis

Definition at line 47 of file SplitLayerNode.cpp.

 {
     return _axis;
 }

Referenced by SplitLayerNode::compute_output_descriptor().

◆ compute_output_descriptor()

std::pair< TensorDescriptor, Coordinates > compute_output_descriptor	(	const TensorDescriptor &	input_descriptor,
		unsigned int	num_splits,
		int	axis,
		unsigned int	idx
	)

Computes split layer output descriptor.

Parameters

[in]	input_descriptor	Descriptor of the input tensor
[in]	num_splits	Number of splits
[in]	axis	Axis to perform the split on
[in]	idx	Index of the split

Returns: A pair with the descriptor of the split and the starting coordinates

Definition at line 52 of file SplitLayerNode.cpp.

 {
     // Handle negative axis, negative index is used to specify axis from the end (e.g. -1 for the last axis).
     int              num_dimension = static_cast<int32_t>(input_descriptor.shape.num_dimensions());
     int              tmp_axis      = wrap_around(axis, num_dimension);
     Coordinates      coords;
     TensorDescriptor output_descriptor = input_descriptor;
     int              split_size        = input_descriptor.shape[tmp_axis] / num_splits;
     if (_size_splits.empty())
     {
         output_descriptor.shape.set(tmp_axis, split_size);
         coords.set(tmp_axis, idx * split_size);
     }
     else
     {
         int split_size = _size_splits[idx];
         if (split_size == -1)
         {
             split_size = input_descriptor.shape[tmp_axis];
             for (unsigned int i = 0; i < _size_splits.size() - 1; ++i)
                 split_size -= _size_splits[i];
         }
         output_descriptor.shape.set(tmp_axis, split_size);
         int coord_value = 0;
         for (unsigned int i = 0; i < idx; ++i)
             coord_value += _size_splits[i];
         coords.set(tmp_axis, coord_value);
     }
  
     return std::make_pair(output_descriptor, coords);
 }

References SplitLayerNode::axis(), Dimensions< T >::num_dimensions(), SplitLayerNode::num_splits(), Dimensions< T >::set(), TensorShape::set(), TensorDescriptor::shape, and arm_compute::wrap_around().

◆ configure_output()

TensorDescriptor configure_output ( size_t idx ) const

overridevirtual

Calculates output configuration.

Parameters

[in] idx Output index to configure

Returns: Output descriptor configuration

Implements INode.

Definition at line 104 of file SplitLayerNode.cpp.

 {
     ARM_COMPUTE_UNUSED(idx);
     ARM_COMPUTE_ERROR_ON(idx >= _outputs.size());
  
     const Tensor *src = input(0);
     ARM_COMPUTE_ERROR_ON(src == nullptr);
  
     TensorDescriptor input_descriptor  = src->desc();
     TensorDescriptor output_descriptor = input_descriptor;
  
     // Handle negative axis, negative index is used to specify axis from the end (e.g. -1 for the last axis).
     int num_dimension = static_cast<int32_t>(src->desc().shape.num_dimensions());
     int tmp_axis      = wrap_around(_axis, num_dimension);
  
     int split_size = (_size_splits.empty()) ? (input_descriptor.shape[tmp_axis] / _num_splits) : _size_splits[idx];
     if (split_size == -1)
     {
         split_size = input_descriptor.shape[tmp_axis];
         for (unsigned int i = 0; i < _size_splits.size() - 1; ++i)
             split_size -= _size_splits[i];
     }
     output_descriptor.shape.set(tmp_axis, split_size);
  
     return output_descriptor;
 }

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_UNUSED, INode::input(), TensorShape::set(), TensorDescriptor::shape, arm_compute::test::validation::src, and arm_compute::wrap_around().

Referenced by SplitLayerNode::forward_descriptors().

◆ forward_descriptors()

bool forward_descriptors ( )

overridevirtual

Forwards descriptor information to outputs if possible.

Returns: True if descriptor information could be forwarded otherwise false

Implements INode.

Definition at line 85 of file SplitLayerNode.cpp.

 {
     if (input_id(0) != NullTensorID)
     {
         validate();
         for (unsigned int i = 0; i < _outputs.size(); ++i)
         {
             if (output_id(i) != NullTensorID)
             {
                 Tensor *dst_i = output(i);
                 ARM_COMPUTE_ERROR_ON(dst_i == nullptr);
                 dst_i->desc() = configure_output(i);
             }
         }
         return true;
     }
     return false;
 }

References ARM_COMPUTE_ERROR_ON, SplitLayerNode::configure_output(), Tensor::desc(), INode::input_id(), arm_compute::graph::NullTensorID, INode::output(), INode::output_id(), and SplitLayerNode::validate().

◆ num_splits()

unsigned int num_splits ( ) const

Number of splits accessor.

Returns: Number of splits

Definition at line 42 of file SplitLayerNode.cpp.

 {
     return _num_splits;
 }

Referenced by SplitLayerNode::compute_output_descriptor(), and SplitLayerNode::SplitLayerNode().

◆ type()

NodeType type ( ) const

overridevirtual

Returns node's type.

Returns: Node's type

Implements INode.

Definition at line 149 of file SplitLayerNode.cpp.

 {
     return NodeType::SplitLayer;
 }

References arm_compute::graph::SplitLayer.

◆ validate()

Status validate ( ) const

overridevirtual

Validate node.

Returns: Status containing any errors

Reimplemented from INode.

Definition at line 131 of file SplitLayerNode.cpp.

 {
     const Tensor *src = input(0);
     ARM_COMPUTE_RETURN_ERROR_ON(src == nullptr);
     int num_dimension = static_cast<int32_t>(src->desc().shape.num_dimensions());
     ARM_COMPUTE_RETURN_ERROR_ON(_axis < (-num_dimension) || _axis >= num_dimension);
  
     // Handle negative axis, negative index is used to specify axis from the end (e.g. -1 for the last axis).
     int tmp_axis = wrap_around(_axis, num_dimension);
  
     if (_size_splits.empty())
     {
         ARM_COMPUTE_RETURN_ERROR_ON_MSG(src->desc().shape[tmp_axis] % _num_splits, "Split should be exact");
     }
  
     return Status{};
 }

References ARM_COMPUTE_RETURN_ERROR_ON, ARM_COMPUTE_RETURN_ERROR_ON_MSG, INode::input(), arm_compute::test::validation::src, and arm_compute::wrap_around().

Referenced by SplitLayerNode::forward_descriptors().

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

arm_compute/graph/nodes/SplitLayerNode.h
src/graph/nodes/SplitLayerNode.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SplitLayerNode()

Member Function Documentation

◆ accept()

◆ axis()

◆ compute_output_descriptor()

◆ configure_output()

◆ forward_descriptors()

◆ num_splits()

◆ type()

◆ validate()