NESubTensorHandle Class Reference

CPU Sub-Tensor handle interface object. More...

#include <NESubTensorHandle.h>

Collaboration diagram for NESubTensorHandle:

Public Member Functions
	NESubTensorHandle (ITensorHandle *parent_handle, const TensorShape &shape, const Coordinates &coords, bool extend_parent=false)
	Default constructor. More...
	~NESubTensorHandle ()=default
	Destructor: free the tensor's memory. More...
	NESubTensorHandle (NESubTensorHandle &&)=default
	Allow instances of this class to be move constructed. More...
NESubTensorHandle &	operator= (NESubTensorHandle &&)=default
	Allow instances of this class to be moved. More...
	NESubTensorHandle (const NESubTensorHandle &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
NESubTensorHandle &	operator= (const NESubTensorHandle &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
void	allocate () override
	Allocates backend memory for the handle. More...
void	free () override
	Allocates backend memory for the handle. More...
void	manage (IMemoryGroup *mg) override
	Set backend tensor to be managed by a memory group. More...
void	map (bool blocking) override
	Maps backend tensor object. More...
void	unmap () override
	Un-maps a backend tensor object. More...
void	release_if_unused () override
	Releases backend tensor if is marked as unused. More...
arm_compute::ITensor &	tensor () override
	Backend tensor object accessor. More...
const arm_compute::ITensor &	tensor () const override
	Backend tensor object const accessor. More...
ITensorHandle *	parent_handle () override
	Return the parent tensor handle if is a subtensor else this. More...
bool	is_subtensor () const override
	Checks if a backing tensor is a sub-tensor object or not. More...
Target	target () const override
	Returns target type. More...
Public Member Functions inherited from ITensorHandle
virtual	~ITensorHandle ()=default
	Default virtual destructor. More...

Detailed Description

CPU Sub-Tensor handle interface object.

Definition at line 38 of file NESubTensorHandle.h.

Constructor & Destructor Documentation

NESubTensorHandle() [1/3]

NESubTensorHandle	(	ITensorHandle *	parent_handle,
		const TensorShape &	shape,
		const Coordinates &	coords,
		bool	extend_parent = false
	)

Default constructor.

Parameters

[in]	parent_handle	Parent tensor handle
[in]	shape	Sub-Tensor shape
[in]	coords	Starting coordinates
[in]	extend_parent	Extends parent shape if true

Definition at line 32 of file NESubTensorHandle.cpp.

References ARM_COMPUTE_ERROR_ON, NESubTensorHandle::parent_handle(), arm_compute::test::validation::shape, and ITensorHandle::tensor().

    : _sub_tensor(), _parent_handle(nullptr)
{
    ARM_COMPUTE_ERROR_ON(!parent_handle);
    _sub_tensor    = arm_compute::SubTensor(&parent_handle->tensor(), shape, coords, extend_parent);
    _parent_handle = parent_handle;
}

~NESubTensorHandle()

~NESubTensorHandle ( )

default

Destructor: free the tensor's memory.

NESubTensorHandle() [2/3]

NESubTensorHandle ( NESubTensorHandle &&  )

default

Allow instances of this class to be move constructed.

NESubTensorHandle() [3/3]

NESubTensorHandle ( const NESubTensorHandle &  )

delete

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

Member Function Documentation

allocate()

void allocate ( )

overridevirtual

Allocates backend memory for the handle.

Implements ITensorHandle.

Definition at line 40 of file NESubTensorHandle.cpp.

{
    // noop
}

free()

void free ( )

overridevirtual

Allocates backend memory for the handle.

Implements ITensorHandle.

Definition at line 45 of file NESubTensorHandle.cpp.

{
    // noop
}

is_subtensor()

bool is_subtensor ( ) const

overridevirtual

Checks if a backing tensor is a sub-tensor object or not.

Returns

True if the backend tensor is a sub-tensor else false

Implements ITensorHandle.

Definition at line 87 of file NESubTensorHandle.cpp.

{
    return true;
}

manage()

void manage ( IMemoryGroup *  mg )

overridevirtual

Set backend tensor to be managed by a memory group.

Parameters

[in]

mg

Memory group

Implements ITensorHandle.

Definition at line 50 of file NESubTensorHandle.cpp.

References ARM_COMPUTE_UNUSED.

{
    ARM_COMPUTE_UNUSED(mg);
    // noop
}

map()

void map ( bool  blocking )

overridevirtual

Maps backend tensor object.

Parameters

[in]

blocking

Flags if the mapping operations should be blocking

Implements ITensorHandle.

Definition at line 56 of file NESubTensorHandle.cpp.

References ARM_COMPUTE_UNUSED.

{
    ARM_COMPUTE_UNUSED(blocking);
}

operator=() [1/2]

NESubTensorHandle& operator= ( NESubTensorHandle &&  )

default

Allow instances of this class to be moved.

operator=() [2/2]

NESubTensorHandle& operator= ( const NESubTensorHandle &  )

delete

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

parent_handle()

ITensorHandle * parent_handle ( )

overridevirtual

Return the parent tensor handle if is a subtensor else this.

Returns

Parent tensor handle

Implements ITensorHandle.

Definition at line 81 of file NESubTensorHandle.cpp.

References ARM_COMPUTE_ERROR_ON, and ITensorHandle::parent_handle().

Referenced by NESubTensorHandle::NESubTensorHandle().

{
    ARM_COMPUTE_ERROR_ON(_parent_handle == nullptr);
    return _parent_handle->parent_handle();
}

release_if_unused()

void release_if_unused ( )

overridevirtual

Releases backend tensor if is marked as unused.

Note

This has no effect on sub-tensors

Warning

Parent tensors don't keep track of sub-tensors, thus if a parent is set as unused then all sub-tensors will be invalidated, on the other hand if a sub-tensor is marked as unused then the parent tensor won't be released

Implements ITensorHandle.

Definition at line 66 of file NESubTensorHandle.cpp.

{
    // noop
}

target()

Target target ( ) const

overridevirtual

Returns target type.

Returns

Target type

Implements ITensorHandle.

Definition at line 92 of file NESubTensorHandle.cpp.

References arm_compute::graph::NEON.

{
    return Target::NEON;
}

tensor() [1/2]

arm_compute::ITensor & tensor ( )

overridevirtual

Backend tensor object accessor.

Implements ITensorHandle.

Definition at line 76 of file NESubTensorHandle.cpp.

{
    return _sub_tensor;
}

tensor() [2/2]

const arm_compute::ITensor & tensor ( ) const

overridevirtual

Backend tensor object const accessor.

Implements ITensorHandle.

Definition at line 71 of file NESubTensorHandle.cpp.

{
    return _sub_tensor;
}

unmap()

void unmap ( )

overridevirtual

Un-maps a backend tensor object.

Implements ITensorHandle.

Definition at line 61 of file NESubTensorHandle.cpp.

{
    // noop
}

---

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

• arm_compute/graph/backends/NEON/NESubTensorHandle.h
• src/graph/backends/NEON/NESubTensorHandle.cpp