Coordinates Class Reference

Coordinates of an item. More...

#include <Coordinates.h>

Collaboration diagram for Coordinates:

Public Member Functions
template<typename... Ts>
constexpr	Coordinates (Ts... coords)
	Constructor to initialize the coordinates. More...
constexpr	Coordinates (const Coordinates &)=default
	Allow instances of this class to be copy constructed. More...
Coordinates &	operator= (const Coordinates &)=default
	Allow instances of this class to be copied. More...
constexpr	Coordinates (Coordinates &&)=default
	Allow instances of this class to be move constructed. More...
Coordinates &	operator= (Coordinates &&)=default
	Allow instances of this class to be moved. More...
	~Coordinates ()=default
	Default destructor. More...
Public Member Functions inherited from Dimensions< int >
	Dimensions (Ts... dims)
	Constructor to initialize the tensor shape. More...
	Dimensions (const Dimensions &)=default
	Allow instances of this class to be copy constructed. More...
	Dimensions (Dimensions &&)=default
	Allow instances of this class to be move constructed. More...
Dimensions &	operator= (const Dimensions &)=default
	Allow instances of this class to be copied. More...
Dimensions &	operator= (Dimensions &&)=default
	Allow instances of this class to be moved. More...
void	set (size_t dimension, int value, bool increase_dim_unit=true)
	Accessor to set the value of one of the dimensions. More...
int	x () const
	Alias to access the size of the first dimension. More...
int	y () const
	Alias to access the size of the second dimension. More...
int	z () const
	Alias to access the size of the third dimension. More...
void	increment (size_t dim, int step=1)
	Increments the given dimension by a step size, avoiding overflows. More...
const int &	operator[] (size_t dimension) const
	Generic accessor to get the size of any dimension. More...
int &	operator[] (size_t dimension)
	Generic accessor to get the size of any dimension. More...
unsigned int	num_dimensions () const
	Returns the effective dimensionality of the tensor. More...
void	set_num_dimensions (size_t num_dimensions)
	Set number of dimensions. More...
void	collapse (const size_t n, const size_t first=0)
	Collapse dimensions. More...
void	collapse_from (size_t start)
	Collapse dimensions starting from a given point. More...
void	remove (size_t idx)
	Remove dimension of a given index. More...
std::array< int, num_max_dimensions >::iterator	begin ()
	Returns a read/write iterator that points to the first element in the dimension array. More...
std::array< int, num_max_dimensions >::const_iterator	begin () const
	Returns a read-only (constant) iterator that points to the first element in the dimension array. More...
std::array< int, num_max_dimensions >::const_iterator	cbegin () const
	Returns a read-only (constant) iterator that points to the first element in the dimension array. More...
std::array< int, num_max_dimensions >::iterator	end ()
	Returns a read/write iterator that points one past the last element in the dimension array. More...
std::array< int, num_max_dimensions >::const_iterator	end () const
	Returns a read-only (constant) iterator that points one past the last element in the dimension array. More...
std::array< int, num_max_dimensions >::const_iterator	cend () const
	Returns a read-only (constant) iterator that points one past the last element in the dimension array. More...

Additional Inherited Members
Static Public Attributes inherited from Dimensions< int >
static constexpr size_t	num_max_dimensions
	Number of dimensions the tensor has. More...

Detailed Description

Coordinates of an item.

Definition at line 37 of file Coordinates.h.

Constructor & Destructor Documentation

Coordinates() [1/3]

constexpr Coordinates ( Ts...  coords )

inlineconstexpr

Constructor to initialize the coordinates.

Parameters

[in]

coords

Values to initialize the dimensions.

Definition at line 45 of file Coordinates.h.

                                        : Dimensions{coords...}
    {
    }

Coordinates() [2/3]

constexpr Coordinates ( const Coordinates &  )

constexprdefault

Allow instances of this class to be copy constructed.

Coordinates() [3/3]

constexpr Coordinates ( Coordinates &&  )

constexprdefault

Allow instances of this class to be move constructed.

~Coordinates()

~Coordinates ( )

default

Default destructor.

Member Function Documentation

operator=() [1/2]

Coordinates& operator= ( const Coordinates &  )

default

Allow instances of this class to be copied.

operator=() [2/2]

Coordinates& operator= ( Coordinates &&  )

default

Allow instances of this class to be moved.

---

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

• arm_compute/core/Coordinates.h