Class for handling arrays of generic data. More...

#include <2dArrayOfStuff.h>

Public Member Functions
Constructor/Destructor methods
	TwoDArray (unsigned int numRows, unsigned int numCols)
	Default constructor. More...

	~TwoDArray ()
	Destructor. More...

Attribute methods
unsigned int	numRows () const
	Number of rows in the array. More...

unsigned int	numCols () const
	Number of columns in the array. More...

void	setLocation (unsigned int i, unsigned int j, T *info)
	Sets the data in a specific location. More...

Accessor methods
T &	operator() (unsigned int i, unsigned int j)
	Returns data stored in a specific location (non-const). More...

const T &	operator() (unsigned int i, unsigned int j) const
	Returns data stored in a specific location (const). More...

Private Attributes
unsigned int	m_numRows

unsigned int	m_numCols

std::vector< std::vector< T * > * >	m_data

Detailed Description

template<class T>
class QUESO::TwoDArray< T >

Class for handling arrays of generic data.

This class handles array of generic data (doubles, ints, strings, structs, etc.).

Definition at line 39 of file 2dArrayOfStuff.h.

Constructor & Destructor Documentation

template<class T >

QUESO::TwoDArray< T >::TwoDArray	(	unsigned int	numRows,
		unsigned int	numCols
	)

Default constructor.

Definition at line 32 of file 2dArrayOfStuff.C.

References QUESO::TwoDArray< T >::m_data, QUESO::TwoDArray< T >::m_numCols, and QUESO::TwoDArray< T >::m_numRows.

   : m_numRows(numRows),
     m_numCols(numCols),
     m_data   (m_numRows,NULL)
 {
   for (unsigned int i = 0; i < m_numRows; ++i) {
     m_data[i] = new std::vector<T*>(m_numCols,NULL);
   }
 }

template<class T >

QUESO::TwoDArray< T >::~TwoDArray ( )

Destructor.

Definition at line 44 of file 2dArrayOfStuff.C.

 {
   for (unsigned int i = 0; i < m_numRows; ++i) {
     for (unsigned int j = 0; j < m_numCols; ++j) {
       if ((*(m_data[i]))[j] != NULL) delete (*(m_data[i]))[j];
     }
     delete m_data[i];
   }
 }

Member Function Documentation

template<class T >

unsigned int QUESO::TwoDArray< T >::numCols ( ) const

Number of columns in the array.

Definition at line 62 of file 2dArrayOfStuff.C.

 {
   return m_numCols;
 }

template<class T >

unsigned int QUESO::TwoDArray< T >::numRows ( ) const

Number of rows in the array.

Definition at line 56 of file 2dArrayOfStuff.C.

 {
   return m_numRows;
 }

template<class T >

T & QUESO::TwoDArray< T >::operator()	(	unsigned int	i,
		unsigned int	j
	)

Returns data stored in a specific location (non-const).

This non-const method returns the generic (templated) data that is stored the position (i,j) of the array.

Definition at line 77 of file 2dArrayOfStuff.C.

References queso_require, and queso_require_less.

 {
   // FIXME - Should this really be active in optimized codes? - RHS
   queso_require_less(i, m_numRows);
   queso_require_less(j, m_numCols);
   queso_require(m_data[i]);
   queso_require((*m_data[i])[j]);
 
   return *(*(m_data[i]))[j];
 }

template<class T >

const T & QUESO::TwoDArray< T >::operator()	(	unsigned int	i,
		unsigned int	j
	)		const

Returns data stored in a specific location (const).

This const method returns the generic (templated) data that is stored the position (i,j) of the array.

Definition at line 89 of file 2dArrayOfStuff.C.

References queso_require, and queso_require_less.

 {
   // FIXME - Should this really be active in optimized codes? - RHS
   queso_require_less(i, m_numRows);
   queso_require_less(j, m_numCols);
   queso_require(m_data[i]);
   queso_require((*m_data[i])[j]);
 
   return *(*(m_data[i]))[j];
 }

template<class T >

void QUESO::TwoDArray< T >::setLocation	(	unsigned int	i,
		unsigned int	j,
		T *	info
	)

Sets the data in a specific location.

This method sets the generic (templated) data info, in the position (i,j) of the array.

Definition at line 68 of file 2dArrayOfStuff.C.

References queso_require_msg.

 {
   queso_require_msg(!((i >= m_numRows) || (j >= m_numCols) || (m_data[i] == NULL)), "invalid situation");
   (*(m_data[i]))[j] = info;
   return;
 }