A two-dimensional array. More...

#include <gf/Array2D.h>

Inheritance diagram for gf::Array2D< T, I >:

Public Member Functions
	Array2D ()
	Default constructor. More...

	Array2D (Vector< I, 2 > size)
	Constructor with a size. More...

	Array2D (Vector< I, 2 > size, const T &value)
	Constructor with a size and a value. More...

	Array2D (const Array2D &)=default
	Default copy constructor. More...

Array2D &	operator= (const Array2D &)=default
	Default copy assignment. More...

	Array2D (Array2D &&)=default
	Default move constructor. More...

Array2D &	operator= (Array2D &&)=default
	Default move assignement. More...

void	swap (Array2D &other)
	Swap with another array. More...

Raw data access
const T *	getDataPtr () const noexcept
	Get the pointer to raw data. More...

std::size_t	getDataSize () const noexcept
	Get the raw data size. More...

constexpr bool	isEmpty () const noexcept
	Check if the array is empty. More...

Elements access
T &	operator() (Vector< I, 2 > pos)
	Get the element at a given 2D position. More...

T &	operator() (std::size_t index)
	Get the element at a given 1D index. More...

const T &	operator() (Vector< I, 2 > pos) const
	Get the element at a given 2D position. More...

const T &	operator() (std::size_t index) const
	Get the element at a given 1D index. More...

Iterators
const T *	begin () const noexcept
	Get an iterator to the first element of the array. More...

const T *	end () const noexcept
	Get an iterator to the element following the last element of the array. More...

T *	begin () noexcept
	Get an iterator to the first element of the array. More...

T *	end () noexcept
	Get an iterator to the element following the last element of the array. More...

Public Member Functions inherited from gf::Index2D< unsigned >
	Index2D ()
	Default constructor. More...

	Index2D (Vector< unsigned, 2 > size)
	Constructor with a size. More...

	Index2D (const Index2D &)=default
	Default copy constructor. More...

	Index2D (Index2D &&)=default
	Default move constructor. More...

Index2D &	operator= (const Index2D &)=default
	Default copy assignment. More...

Index2D &	operator= (Index2D &&)=default
	Default move assignement. More...

void	swap (Index2D &other)
	Swap with another array. More...

constexpr Vector< unsigned, 2 >	getSize () const noexcept
	Get the size of the array. More...

constexpr unsigned	getCols () const noexcept
	Get the number of columns. More...

constexpr unsigned	getRows () const noexcept
	Get the number of rows. More...

constexpr bool	isValid (Vector< unsigned, 2 > pos) const noexcept
	Check if a position is valid. More...

constexpr Vector< unsigned, 2 >	toPosition (std::size_t index) const noexcept
	Transform a 1D position into a 2D position. More...

constexpr std::size_t	toIndex (Vector< unsigned, 2 > pos) const noexcept
	Transform a 2D position into a 1D position. More...

constexpr RangeZ	getIndexRange () const noexcept
	Get the 1D index range of the array. More...

constexpr Range< unsigned >	getRowRange () const noexcept
	Get the row range. More...

constexpr Range< unsigned >	getColRange () const noexcept
	Get the column range. More...

constexpr PositionRange< unsigned >	getPositionRange () const noexcept
	Get the position range. More...

NeighborSquareRange< unsigned >	get8NeighborsRange (Vector< unsigned, 2 > pos) const noexcept
	Get a range for 8 neighbors (at most) More...

NeighborSquareRange< unsigned >	get24NeighborsRange (Vector< unsigned, 2 > pos) const noexcept
	Get a range for 24 neighbors (at most) More...

NeighborDiamondRange< unsigned >	get4NeighborsRange (Vector< unsigned, 2 > pos) const noexcept
	Get a range for 4 neighbors (at most) More...

NeighborDiamondRange< unsigned >	get12NeighborsRange (Vector< unsigned, 2 > pos) const noexcept
	Get a range for 12 neighbors (at most) More...

Related Functions
(Note that these are not member functions.)
template<typename T , typename I >
bool	operator== (const Array2D< T, I > &lhs, const Array2D< T, I > &rhs)
	Equality operator for 2D array. More...

template<typename T , typename I >
Serializer &	operator\| (Serializer &ar, const Array2D< T, I > &array)
	Serialize a 2D array. More...

template<typename T , typename I >
Deserializer &	operator\| (Deserializer &ar, Array2D< T, I > &array)
	Deserialize a 2D array. More...

Detailed Description

template<typename T, typename I = unsigned>
class gf::Array2D< T, I >

A two-dimensional array.

gf::Array represents a two-dimensional array, organized in row-major order.

The array is templated with the type of the data and the type of the indices (defaults to unsigned).

Contrary to the usual way of accessing 2D arrays, the first coordinate is the column and the second coordinate is the row. So that, if size is the size of the array and pos is the position in the array:

\( 0 \leq \mathtt{pos.x} = \mathtt{pos.col} < \mathtt{size.width} = \mathtt{size.col} \)
\( 0 \leq \mathtt{pos.y} = \mathtt{pos.row} < \mathtt{size.height} = \mathtt{size.row} \)

Some convinient visitors are provided to visit the four neighbors (up, down, left and right), or the eight neighbors.

See also: gf::Matrix

Constructor & Destructor Documentation

◆ Array2D() [1/5]

template<typename T , typename I = unsigned>

gf::Array2D< T, I >::Array2D ( )

inline

Default constructor.

Creates an empty array.

◆ Array2D() [2/5]

template<typename T , typename I = unsigned>

gf::Array2D< T, I >::Array2D ( Vector< I, 2 > size )

inline

Constructor with a size.

Parameters

size	The size of the array

◆ Array2D() [3/5]

template<typename T , typename I = unsigned>

gf::Array2D< T, I >::Array2D	(	Vector< I, 2 >	size,
		const T &	value
	)

inline

Constructor with a size and a value.

Parameters

size	The size of the array
value	The initial value in the array

◆ Array2D() [4/5]

template<typename T , typename I = unsigned>

gf::Array2D< T, I >::Array2D ( const Array2D< T, I > & )

default

Default copy constructor.

◆ Array2D() [5/5]

template<typename T , typename I = unsigned>

gf::Array2D< T, I >::Array2D ( Array2D< T, I > && )

default

Default move constructor.

Member Function Documentation

◆ begin() [1/2]

template<typename T , typename I = unsigned>

const T * gf::Array2D< T, I >::begin ( ) const

inlinenoexcept

Get an iterator to the first element of the array.

Returns: A begin iterator to the array

See also: end()

◆ begin() [2/2]

template<typename T , typename I = unsigned>

T * gf::Array2D< T, I >::begin ( )

inlinenoexcept

Get an iterator to the first element of the array.

Returns: A begin iterator to the array

See also: end()

◆ end() [1/2]

template<typename T , typename I = unsigned>

const T * gf::Array2D< T, I >::end ( ) const

inlinenoexcept

Get an iterator to the element following the last element of the array.

Returns: An end iterator to the array

See also: begin()

◆ end() [2/2]

template<typename T , typename I = unsigned>

T * gf::Array2D< T, I >::end ( )

inlinenoexcept

Get an iterator to the element following the last element of the array.

Returns: An end iterator to the array

See also: begin()

◆ getDataPtr()

template<typename T , typename I = unsigned>

const T * gf::Array2D< T, I >::getDataPtr ( ) const

inlinenoexcept

Get the pointer to raw data.

The returned pointer is const so you can not modify the array with this function.

Returns: The pointer to raw data

◆ getDataSize()

template<typename T , typename I = unsigned>

std::size_t gf::Array2D< T, I >::getDataSize ( ) const

inlinenoexcept

Get the raw data size.

Returns: The total number of elements in the array

◆ isEmpty()

template<typename T , typename I = unsigned>

constexpr bool gf::Array2D< T, I >::isEmpty ( ) const

inlineconstexprnoexcept

Check if the array is empty.

An empty array is an array with \( 0 \) elements, i.e. either the number of columns is \( 0 \) or the number of rows is \( 0 \).

Returns: True if the array is empty

◆ operator()() [1/4]

template<typename T , typename I = unsigned>

T & gf::Array2D< T, I >::operator() ( std::size_t index )

inline

Get the element at a given 1D index.

Parameters

index The 1D index of the element

See also: getPositionRange()

◆ operator()() [2/4]

template<typename T , typename I = unsigned>

const T & gf::Array2D< T, I >::operator() ( std::size_t index ) const

inline

Get the element at a given 1D index.

Parameters

index The 1D index of the element

See also: getPositionRange()

◆ operator()() [3/4]

template<typename T , typename I = unsigned>

T & gf::Array2D< T, I >::operator() ( Vector< I, 2 > pos )

inline

Get the element at a given 2D position.

Parameters

pos	The 2D position of the element

◆ operator()() [4/4]

template<typename T , typename I = unsigned>

const T & gf::Array2D< T, I >::operator() ( Vector< I, 2 > pos ) const

inline

Get the element at a given 2D position.

Parameters

pos	The 2D position of the element

◆ operator=() [1/2]

template<typename T , typename I = unsigned>

Array2D & gf::Array2D< T, I >::operator= ( Array2D< T, I > && )

default

Default move assignement.

◆ operator=() [2/2]

template<typename T , typename I = unsigned>

Array2D & gf::Array2D< T, I >::operator= ( const Array2D< T, I > & )

default

Default copy assignment.

◆ swap()

template<typename T , typename I = unsigned>

void gf::Array2D< T, I >::swap ( Array2D< T, I > & other )

inline

Swap with another array.

Parameters

other An other array

Friends And Related Function Documentation

◆ operator==()

template<typename T , typename I >

bool operator==	(	const Array2D< T, I > &	lhs,
		const Array2D< T, I > &	rhs
	)

◆ operator|() [1/2]

template<typename T , typename I >

Deserializer & operator\|	(	Deserializer &	ar,
		Array2D< T, I > &	array
	)

◆ operator|() [2/2]

template<typename T , typename I >

Serializer & operator\|	(	Serializer &	ar,
		const Array2D< T, I > &	array
	)

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Array2D() [1/5]

◆ Array2D() [2/5]

◆ Array2D() [3/5]

◆ Array2D() [4/5]

◆ Array2D() [5/5]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ getDataPtr()

◆ getDataSize()

◆ isEmpty()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ swap()

Friends And Related Function Documentation

◆ operator==()

◆ operator|() [1/2]

◆ operator|() [2/2]