Interface for NEON tensor. More...

#include <ITensor.h>

Public Member Functions
virtual ITensorInfo *	info () const =0
	Interface to be implemented by the child class to return the tensor's metadata. More...

virtual ITensorInfo *	info ()=0
	Interface to be implemented by the child class to return the tensor's metadata. More...

virtual	~ITensor ()=default
	Default virtual destructor. More...

virtual uint8_t *	buffer () const =0
	Interface to be implemented by the child class to return a pointer to CPU memory. More...

uint8_t *	ptr_to_element (const Coordinates &id) const
	Return a pointer to the element at the passed coordinates. More...

void	copy_from (const ITensor &src)
	Copy the content of another tensor. More...

void	print (std::ostream &s, IOFormatInfo io_fmt=IOFormatInfo()) const
	Print a tensor to a given stream using user defined formatting information. More...

bool	is_used () const
	Flags if the tensor is used or not. More...

void	mark_as_unused () const
	Marks a tensor as unused. More...

Detailed Description

Interface for NEON tensor.

Definition at line 36 of file ITensor.h.

Constructor & Destructor Documentation

◆ ~ITensor()

virtual ~ITensor ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

◆ buffer()

virtual uint8_t* buffer ( ) const

pure virtual

Interface to be implemented by the child class to return a pointer to CPU memory.

Returns: A CPU pointer to the beginning of the image's allocation.

Implemented in ICLTensor, GCTensor, IGCTensor, SubTensor, and Tensor.

Referenced by SubTensor::buffer(), Accessor::data(), arm_compute::utils::draw_detection_rectangle(), Iterator::Iterator(), NEDepthwiseConvolutionAssemblyDispatch::prepare(), ITensor::ptr_to_element(), CPPUpsampleKernel::run(), NEROIPoolingLayerKernel::run(), NEReorgLayerKernel::run(), NEWidthConcatenateLayerKernel::run(), NEHeightConcatenateLayerKernel::run(), NECannyEdge::run(), NEDirectConvolutionLayerKernel::run(), and NEDepthwiseConvolutionAssemblyDispatch::run().

◆ copy_from()

void copy_from ( const ITensor & src )

Copy the content of another tensor.

Note: The number of dimensions of the source tensor must be less or equal to those of the destination tensor.; All dimensions of the destination tensor must be greater or equal to the source tensor ones.; num_channels() and element_size() of both tensors must match.

Parameters

[in] src Source tensor to copy from.

Definition at line 35 of file ITensor.cpp.

 {
     if(&src == this)
     {
         return;
     }
 
     const ITensorInfo *src_info = src.info();
     ITensorInfo       *dst_info = this->info();
 
     ARM_COMPUTE_ERROR_ON(src_info->num_dimensions() > dst_info->num_dimensions());
     ARM_COMPUTE_ERROR_ON(src_info->num_channels() != dst_info->num_channels());
     ARM_COMPUTE_ERROR_ON(src_info->element_size() != dst_info->element_size());
 
     for(size_t d = 0; d < src_info->num_dimensions(); d++)
     {
         ARM_COMPUTE_ERROR_ON(src_info->dimension(d) > dst_info->dimension(d));
     }
 
     // Copy information about valid region
     dst_info->set_valid_region(src_info->valid_region());
 
     Window win_src;
     win_src.use_tensor_dimensions(src_info->tensor_shape(), Window::DimY);
     Window win_dst;
     win_dst.use_tensor_dimensions(dst_info->tensor_shape(), Window::DimY);
 
     Iterator src_it(&src, win_src);
     Iterator dst_it(this, win_dst);
 
     const size_t line_size = src_info->element_size() * src_info->dimension(0);
 
     execute_window_loop(win_src, [&](const Coordinates &)
     {
         memcpy(dst_it.ptr(), src_it.ptr(), line_size);
     },
     src_it, dst_it);
 }

References ARM_COMPUTE_ERROR_ON, ITensorInfo::dimension(), TensorInfo::dimension(), Window::DimY, ITensorInfo::element_size(), TensorInfo::element_size(), arm_compute::execute_window_loop(), ITensor::info(), ITensorInfo::num_channels(), TensorInfo::num_channels(), ITensorInfo::num_dimensions(), TensorInfo::num_dimensions(), Iterator::ptr(), ITensorInfo::set_valid_region(), arm_compute::test::validation::src, arm_compute::test::validation::src_info, ITensorInfo::tensor_shape(), TensorInfo::tensor_shape(), Window::use_tensor_dimensions(), and TensorInfo::valid_region().

◆ info() [1/2]

virtual ITensorInfo* info ( ) const

pure virtual

Interface to be implemented by the child class to return the tensor's metadata.

Returns: A pointer to the tensor's metadata.

Implemented in CLSubTensor, GCTensor, CLTensor, SubTensor, and Tensor.

◆ info() [2/2]

virtual ITensorInfo* info ( )

pure virtual

Interface to be implemented by the child class to return the tensor's metadata.

Returns: A pointer to the tensor's metadata.

Implemented in CLSubTensor, GCTensor, CLTensor, SubTensor, and Tensor.

◆ is_used()

bool is_used ( ) const

Flags if the tensor is used or not.

Returns: True if it is used else false

Definition at line 162 of file ITensor.cpp.

 {
     return _is_used;
 }

Referenced by GCFullyConnectedLayer::prepare(), NELocallyConnectedLayer::prepare(), CLLocallyConnectedLayer::prepare(), GCGEMM::prepare(), CLGEMMLowpMatrixMultiplyCore::prepare(), CLWinogradConvolutionLayer::prepare(), NEGEMM::prepare(), NEGEMMLowpMatrixMultiplyCore::prepare(), NEFFTConvolutionLayer::prepare(), CLFFTConvolutionLayer::prepare(), GCConvolutionLayer::prepare(), CLGEMMDeconvolutionLayer::prepare(), NEDeconvolutionLayer::prepare(), CLDirectDeconvolutionLayer::prepare(), NEFullyConnectedLayer::prepare(), CLFullyConnectedLayer::prepare(), NEGEMMConvolutionLayer::prepare(), CLGEMMConvolutionLayer::prepare(), CLTensorHandle::release_if_unused(), NETensorHandle::release_if_unused(), and GCTensorHandle::release_if_unused().

◆ mark_as_unused()

void mark_as_unused ( ) const

Marks a tensor as unused.

Definition at line 167 of file ITensor.cpp.

 {
     _is_used = false;
 }

◆ print()

void print	(	std::ostream &	s,
		IOFormatInfo	io_fmt = `IOFormatInfo()`
	)		const

Print a tensor to a given stream using user defined formatting information.

Parameters

s	Output stream
io_fmt	Format information

Referenced by arm_compute::test::print_tensor().

◆ ptr_to_element()

uint8_t* ptr_to_element ( const Coordinates & id ) const

inline

Return a pointer to the element at the passed coordinates.

Parameters

[in] id Coordinates of the element

Returns: Pointer to the requested element

Definition at line 63 of file ITensor.h.

     {
         return buffer() + info()->offset_element_in_bytes(id);
     }

References ITensor::buffer(), ITensor::info(), and ITensorInfo::offset_element_in_bytes().

Referenced by CLGEMMLowpMatrixMultiplyCore::configure(), NECropKernel::configure_output_shape(), CPPFlipWeightsKernel::flip_weights(), GCAccessor::operator()(), Accessor::operator()(), CLAccessor::operator()(), NEIntegralImageKernel::run(), NEMemsetKernel::run(), NETileKernel::run(), CPPDetectionOutputLayer::run(), NEDepthToSpaceLayerKernel::run(), NESpaceToDepthLayerKernel::run(), NEROIPoolingLayerKernel::run(), NEScharr3x3Kernel::run(), NESobel3x3Kernel::run(), CPPNonMaximumSuppressionKernel::run(), CPPDetectionPostProcessLayer::run(), NEBatchToSpaceLayerKernel::run(), NECropResize::run(), NECropKernel::run(), NESpaceToBatchLayerKernel::run(), NEWeightsReshapeKernel::run(), NESobel5x5VertKernel::run(), CPPBoxWithNonMaximaSuppressionLimitKernel::run_nmslimit(), and arm_compute::run_reverse().

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

arm_compute/core/ITensor.h
src/core/ITensor.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ITensor()

Member Function Documentation

◆ buffer()

◆ copy_from()

◆ info() [1/2]

◆ info() [2/2]

◆ is_used()

◆ mark_as_unused()

◆ print()

◆ ptr_to_element()