tbq::Array2D< T > Class Template Reference

Use to manage a 2-dimensional array. More...

#include <array2d.h>

Public Member Functions
	Array2D ()
	Construct an empty 2D array.
	Array2D (size_t nbRows, size_t nbCols)
	Construct a 2D array at specified size.
size_t	getRows () const
	Get number of rows.
size_t	getCols () const
	Get number of columns.
size_t	getSize () const
	Get total size of 2D array (a.k.a number of elements)
void	clear ()
	Clear content of 2D array.
void	resize (size_t nbRows, size_t nbCols)
	Resize array to specified size.
void	insert (size_t row, size_t col, const T &value)
	Use to insert a value at specified indexes.
T &	operator() (size_t row, size_t col)
	Get modifiable reference to an element.
const T &	operator() (size_t row, size_t col) const
	Get constant reference to an element.

Friends
bool	operator== (const Array2D< T > &left, const Array2D< T > &right)
bool	operator!= (const Array2D< T > &left, const Array2D< T > &right)

Detailed Description

template<typename T>
class tbq::Array2D< T >

Use to manage a 2-dimensional array.

Constructor & Destructor Documentation

Array2D()

template<typename T >

tbq::Array2D< T >::Array2D ( size_t nbRows, size_t nbCols )

explicit

Construct a 2D array at specified size.

Parameters

[in]	nbRows	Number of rows.
[in]	nbCols	Number of colums

Member Function Documentation

getRows()

template<typename T >

size_t tbq::Array2D< T >::getRows

(

)

const

Get number of rows.

Returns

Returns number of rows available

See also

getCols(), getSize()

getCols()

template<typename T >

size_t tbq::Array2D< T >::getCols

(

)

const

Get number of columns.

Returns

Returns number of columns available

See also

getRows(), getSize()

getSize()

template<typename T >

size_t tbq::Array2D< T >::getSize

(

)

const

Get total size of 2D array (a.k.a number of elements)

Returns

Returns number of elements

See also

getRows(), getCols()

clear()

template<typename T >

void tbq::Array2D< T >::clear

(

)

Clear content of 2D array.

Size will be reset to 0 and all elements will be removed

Note

This method doesn't impact internal capacity of the array, see resize() method for more details.

See also

resize()

resize()

template<typename T >

void tbq::Array2D< T >::resize	(	size_t	nbRows,
		size_t	nbCols )

Resize array to specified size.

Parameters

[in]	nbRows	Number of rows.
[in]	nbCols	Number of colums

Note

This method will only extend capacity of the 2D array, no shrink operation will be performed.

insert()

template<typename T >

void tbq::Array2D< T >::insert	(	size_t	row,
		size_t	col,
		const T &	value )

Use to insert a value at specified indexes.

Parameters

[in]	row	Row index to use. Must be valid (i.e 0 <= row < getRows()).
[in]	col	Column index to use. Must be valid (i.e 0 <= col < getCols()).
[in]	value	Value to insert

operator()() [1/2]

template<typename T >

T & tbq::Array2D< T >::operator()	(	size_t	row,
		size_t	col )

Get modifiable reference to an element.

Parameters

[in]	row	Row index to use. Must be valid (i.e 0 <= row < getRows()).
[in]	col	Column index to use. Must be valid (i.e 0 <= col < getCols()).

Returns

Returns modifiable reference to an element

operator()() [2/2]

template<typename T >

const T & tbq::Array2D< T >::operator()	(	size_t	row,
		size_t	col ) const

Get constant reference to an element.

Parameters

[in]	row	Row index to use. Must be valid (i.e 0 <= row < getRows()).
[in]	col	Column index to use. Must be valid (i.e 0 <= col < getCols()).

Returns

Returns constant reference to an element

---

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

• include/toolboxqt/containers/array2d.h