Iterator updated by execute_window_loop for each window element. More...

#include <Helpers.h>

Public Member Functions
constexpr	Iterator ()
	Default constructor to create an empty iterator. More...

	Iterator (const ITensor *tensor, const Window &window)
	Create a container iterator for the metadata and allocation contained in the ITensor. More...

	Iterator (size_t num_dims, const Strides &strides, uint8_t *buffer, size_t offset, const Window &window)
	Create a container iterator for the tensor with the specified number of dimensions, stride, buffer pointer and window. More...

void	increment (size_t dimension)
	Increment the iterator along the specified dimension of the step value associated to the dimension. More...

constexpr size_t	offset () const
	Return the offset in bytes from the first element to the current position of the iterator. More...

constexpr uint8_t *	ptr () const
	Return a pointer to the current pixel. More...

void	reset (size_t dimension)
	Move the iterator back to the beginning of the specified dimension. More...

Detailed Description

Iterator updated by execute_window_loop for each window element.

Definition at line 46 of file Helpers.h.

Constructor & Destructor Documentation

◆ Iterator() [1/3]

constexpr Iterator ( )

inline

Default constructor to create an empty iterator.

Definition at line 90 of file Helpers.inl.

     : _ptr(nullptr), _dims()
 {
 }

◆ Iterator() [2/3]

Iterator	(	const ITensor *	tensor,
		const Window &	window
	)

inline

Create a container iterator for the metadata and allocation contained in the ITensor.

Parameters

[in]	tensor	The tensor to associate to the iterator.
[in]	window	The window which will be used to iterate over the tensor.

Definition at line 95 of file Helpers.inl.

References ARM_COMPUTE_ERROR_ON, ITensor::buffer(), ITensor::info(), ITensorInfo::num_dimensions(), ITensorInfo::offset_first_element_in_bytes(), and ITensorInfo::strides_in_bytes().

     : Iterator()
 {
     ARM_COMPUTE_ERROR_ON(tensor == nullptr);
     ARM_COMPUTE_ERROR_ON(tensor->info() == nullptr);
 
     initialize(tensor->info()->num_dimensions(), tensor->info()->strides_in_bytes(), tensor->buffer(), tensor->info()->offset_first_element_in_bytes(), win);
 }

◆ Iterator() [3/3]

Iterator	(	size_t	num_dims,
		const Strides &	strides,
		uint8_t *	buffer,
		size_t	offset,
		const Window &	window
	)

inline

Create a container iterator for the tensor with the specified number of dimensions, stride, buffer pointer and window.

Parameters

[in]	num_dims	The number of dimensions.
[in]	strides	The strides in bytes.
[in]	buffer	The data buffer.
[in]	offset	The offset in bytes from the beginning of the buffer to the first element of the tensor.
[in]	window	The window which will be used to iterate over the tensor.

Definition at line 104 of file Helpers.inl.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_WINDOW_DIMENSIONS_GTE, arm_compute::test::validation::n, Dimensions< int >::num_max_dimensions, and Iterator::offset().

     : Iterator()
 {
     initialize(num_dims, strides, buffer, offset, win);
 }

Member Function Documentation

◆ increment()

void increment ( size_t dimension )

inline

Increment the iterator along the specified dimension of the step value associated to the dimension.

Warning: It is the caller's responsibility to call increment(dimension+1) when reaching the end of a dimension, the iterator will not check for overflow.

Note: When incrementing a dimension 'n' the coordinates of all the dimensions in the range (0,n-1) are reset. For example if you iterate over a 2D image, everytime you change row (dimension 1), the iterator for the width (dimension 0) is reset to its start.

Parameters

[in] dimension Dimension to increment

Definition at line 132 of file Helpers.inl.

References ARM_COMPUTE_ERROR_ON, arm_compute::test::validation::n, and Dimensions< int >::num_max_dimensions.

 {
     ARM_COMPUTE_ERROR_ON(dimension >= Coordinates::num_max_dimensions);
 
     _dims[dimension]._dim_start += _dims[dimension]._stride;
 
     for(unsigned int n = 0; n < dimension; ++n)
     {
         _dims[n]._dim_start = _dims[dimension]._dim_start;
     }
 }

◆ offset()

constexpr size_t offset ( ) const

inline

Return the offset in bytes from the first element to the current position of the iterator.

Returns: The current position of the iterator in bytes relative to the first element.

Definition at line 144 of file Helpers.inl.

Referenced by Iterator::Iterator(), arm_compute::cpu::poolingMxN_q8_neon_nhwc(), CpuFillKernel::run_op(), CpuConcatenateHeightKernel::run_op(), CpuConcatenateWidthKernel::run_op(), and NEFillBorderKernel::run_op().

 {
     return _dims.at(0)._dim_start;
 }

◆ ptr()

constexpr uint8_t * ptr ( ) const

inline

Return a pointer to the current pixel.

Warning: Only works if the iterator was created with an ITensor.

Returns: equivalent to buffer() + offset()

Definition at line 149 of file Helpers.inl.

 {
     return _ptr + _dims.at(0)._dim_start;
 }

◆ reset()

void reset ( size_t dimension )

inline

Move the iterator back to the beginning of the specified dimension.

Parameters

[in] dimension Dimension to reset

Definition at line 154 of file Helpers.inl.

References ARM_COMPUTE_ERROR_ON, arm_compute::test::validation::n, and Dimensions< int >::num_max_dimensions.

 {
     ARM_COMPUTE_ERROR_ON(dimension >= Coordinates::num_max_dimensions - 1);
 
     _dims[dimension]._dim_start = _dims[dimension + 1]._dim_start;
 
     for(unsigned int n = 0; n < dimension; ++n)
     {
         _dims[n]._dim_start = _dims[dimension]._dim_start;
     }
 }

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

arm_compute/core/Helpers.h
arm_compute/core/Helpers.inl

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Iterator() [1/3]

◆ Iterator() [2/3]

◆ Iterator() [3/3]

Member Function Documentation

◆ increment()

◆ offset()

◆ ptr()

◆ reset()