Array2D Class Reference

A class for 2D arrays stored in column-major (Fortran-compatible) form. More...

#include <Array.h>

Public Types
typedef vector_fp::iterator	iterator
	Type definition for the iterator class that is can be used by Array2D types.
typedef vector_fp::const_iterator	const_iterator
	Type definition for the const_iterator class that is can be used by Array2D types.
Public Member Functions
	Array2D ()
	Default constructor.
	Array2D (const int m, const int n, const doublereal v=0.0)
	Constructor.
	Array2D (const Array2D &y)
	Copy constructor.
Array2D &	operator= (const Array2D &y)
	assignment operator
void	resize (int n, int m, doublereal v=0.0)
	Resize the array, and fill the new entries with 'v'.
void	appendColumn (const vector_fp &c)
	Append a column to the existing matrix using a std vector.
void	appendColumn (const doublereal *const c)
	Append a column to the existing matrix.
void	setRow (int n, const doublereal *const rw)
	Set the nth row to array rw.
void	getRow (int n, doublereal *const rw)
	Get the nth row and return it in a vector.
void	setColumn (int m, doublereal *const col)
	Set the values in column m to those in array col.
void	getColumn (int m, doublereal *const col)
	Get the values in column m.
virtual	~Array2D ()
	Destructor.
void	axpy (doublereal a, const Array2D &x, const Array2D &y)
	Evaluate z = a*x + y.
doublereal &	operator() (int i, int j)
	Allows setting elements using the syntax A(i,j) = x.
doublereal	operator() (int i, int j) const
	Allows retrieving elements using the syntax x = A(i,j).
doublereal &	value (int i, int j)
	Returns a changeable reference to position in the matrix.
doublereal	value (int i, int j) const
	Returns the value of a single matrix entry.
size_t	nRows () const
	Number of rows.
size_t	nColumns () const
	Number of columns.
iterator	begin ()
	Return an iterator pointing to the first element.
iterator	end ()
	Return an iterator pointing past the last element.
const_iterator	begin () const
	Return a const iterator pointing to the first element.
const_iterator	end () const
	Return a const iterator pointing to past the last element.
vector_fp &	data ()
	Return a reference to the data vector.
const vector_fp &	data () const
	Return a const reference to the data vector.
doublereal *	ptrColumn (int j)
	Return a pointer to the top of column j, columns are contiguous in memory.
const doublereal *	ptrColumn (int j) const
	Return a const pointer to the top of column j, columns are contiguous in memory.
Protected Attributes
vector_fp	m_data
	Data storred in a single array.
int	m_nrows
	Number of rows.
int	m_ncols
	Number of columns.

Detailed Description

A class for 2D arrays stored in column-major (Fortran-compatible) form.

In this form, the data entry for an n row, m col matrix is index = i + (n-1) * j where J(i,j) = data_start + index i = row j = column

Definition at line 36 of file Array.h.

Member Typedef Documentation

typedef vector_fp::const_iterator const_iterator

Type definition for the const_iterator class that is can be used by Array2D types.

this is just equal to vector_fp const_iterator.

Definition at line 38 of file Array.h.

typedef vector_fp::iterator iterator

Type definition for the iterator class that is can be used by Array2D types.

this is just equal to vector_fp iterator.

Definition at line 30 of file Array.h.

Constructor & Destructor Documentation

Array2D ( ) [inline]

Default constructor.

Create an empty array.

Definition at line 43 of file Array.h.

Array2D	(	const int	m,
		const int	n,
		const doublereal	v = `0.0`
	)			`[inline]`

Constructor.

Create an m by n array, and initialize all elements to v.

Parameters:

	m	Number of rows
	n	Number of columns
	v	Default fill value. The default is 0.0

Definition at line 56 of file Array.h.

References Array2D::m_data.

Array2D ( const Array2D & y ) [inline]

Copy constructor.

Parameters:

y

Array2D to make the copy from

Definition at line 66 of file Array.h.

References Array2D::m_data.

virtual ~Array2D ( ) [inline, virtual]

Destructor.

Does nothing, since no memory allocated on the heap.

Definition at line 182 of file Array.h.

References Array2D::m_data, and Array2D::m_nrows.

Member Function Documentation

void appendColumn ( const doublereal *const c ) [inline]

Append a column to the existing matrix.

This operation will add a column onto the existing matrix.

Parameters:

c

This vector of doubles is the entries in the column to be added. It must have a length equal to m_nrows or greater.

Definition at line 121 of file Array.h.

References Array2D::m_data, Array2D::m_ncols, Array2D::m_nrows, and Array2D::value().

void appendColumn ( const vector_fp & c ) [inline]

Append a column to the existing matrix using a std vector.

This operation will add a column onto the existing matrix.

Parameters:

c

This vector<doublereal> is the entries in the column to be added. It must have a length equal to m_nrows or greater.

Definition at line 106 of file Array.h.

References Array2D::m_data, Array2D::m_ncols, and Array2D::m_nrows.

void axpy	(	doublereal	a,
		const Array2D &	x,
		const Array2D &	y
	)			`[inline]`

Evaluate z = a*x + y.

This function evaluates the AXPY operation, and stores the result in the object's Array2D object. It's assumed that all 3 objects have the same dimensions, but no error checking is done.

Parameters: