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

#include <Array.h>

Inheritance diagram for Array2D:

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 size_t m, const size_t n, const doublereal v=0.0)
	Constructor.

	Array2D (const size_t m, const size_t n, const doublereal *values)
	Constructor.

	Array2D (const Array2D &y)
	Copy constructor.

Array2D &	operator= (const Array2D &y)
	assignment operator

void	resize (size_t n, size_t m, doublereal v=0.0)
	Resize the array, and fill the new entries with 'v'.

void	copyData (const Array2D &y)
	Copy the data from one array into another without doing any checking.

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 (size_t n, const doublereal *const rw)
	Set the nth row to array rw.

void	getRow (size_t n, doublereal *const rw)
	Get the nth row and return it in a vector.

void	setColumn (size_t m, doublereal *const col)
	Set the values in column m to those in array col.

void	getColumn (size_t 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.

void	zero ()
	Set all of the entries to zero.

doublereal &	operator() (size_t i, size_t j)
	Allows setting elements using the syntax A(i,j) = x.

doublereal	operator() (size_t i, size_t j) const
	Allows retrieving elements using the syntax x = A(i,j).

doublereal &	value (size_t i, size_t j)
	Returns a changeable reference to position in the matrix.

doublereal	value (size_t i, size_t 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 (size_t j)
	Return a pointer to the top of column j, columns are contiguous in memory.

const doublereal *	ptrColumn (size_t j) const
	Return a const pointer to the top of column j, columns are contiguous in memory.

Protected Attributes
vector_fp	m_data
	Data stored in a single array.

size_t	m_nrows
	Number of rows.

size_t	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 33 of file Array.h.

Member Typedef Documentation

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 43 of file Array.h.

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 51 of file Array.h.

Constructor & Destructor Documentation

Array2D ( )

inline

Default constructor.

Create an empty array.

Definition at line 56 of file Array.h.

Array2D	(	const size_t	m,
		const size_t	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 71 of file Array.h.

References Array2D::m_data.

Array2D	(	const size_t	m,
		const size_t	n,
		const doublereal *	values
	)

inline

Constructor.

Create an m by n array, initialized with the contents of the array values.

Parameters

m	Number of rows
n	Number of columns
values	Initial values of the array. Must be of length m*n, and stored in column-major order.

Definition at line 87 of file Array.h.

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

Array2D ( const Array2D & y )

inline

Copy constructor.

Parameters

y	Array2D to make the copy from

Definition at line 97 of file Array.h.

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

virtual ~Array2D ( )

inlinevirtual

Destructor.

Does nothing, since no memory allocated on the heap.

Definition at line 232 of file Array.h.

Member Function Documentation

Array2D& operator= ( const Array2D & y )

inline

assignment operator

Parameters

y	Array2D to get the values from

Definition at line 111 of file Array.h.

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

Referenced by DenseMatrix::operator=().

void resize	(	size_t	n,
		size_t	m,
		doublereal	v = `0.0`
	)

inline

Resize the array, and fill the new entries with 'v'.

Parameters

n	This is the number of rows
m	This is the number of columns in the new matrix
v	Default fill value -> defaults to zero.

Definition at line 128 of file Array.h.

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

Referenced by GibbsExcessVPSSTP::initLengths(), RedlichKwongMFTP::initLengths(), IonsFromNeutralVPSSTP::initLengths(), PhaseCombo_Interaction::initLengths(), RedlichKisterVPSSTP::initLengths(), MargulesVPSSTP::initLengths(), MixedSolventElectrolyte::initLengths(), DebyeHuckel::initLengths(), HMWSoln::initLengths(), LiquidTransport::initLiquid(), DenseMatrix::resize(), StFlow::resize(), RedlichKisterVPSSTP::resizeNumInteractions(), StFlow::setTransport(), solveProb::solveProb(), solveSP::solveSP(), AqueousTransport::stefan_maxwell_solve(), and StFlow::StFlow().

void copyData ( const Array2D & y )

inline

Copy the data from one array into another without doing any checking.

This differs from the assignment operator as no resizing is done and memcpy() is used.

Parameters

y	Array to be copied

Definition at line 139 of file Array.h.

References DATA_PTR, Array2D::m_data, Array2D::m_ncols, Array2D::m_nrows, and Array2D::ptrColumn().

Referenced by SquareMatrix::copyData().

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 152 of file Array.h.

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

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 169 of file Array.h.

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

void setRow	(	size_t	n,
		const doublereal *const	rw
	)

inline

Set the nth row to array rw.

Parameters

n	Index of the row to be changed
rw	Vector for the row. Must have a length of m_ncols.

Definition at line 183 of file Array.h.

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

void getRow	(	size_t	n,
		doublereal *const	rw
	)

inline

Get the nth row and return it in a vector.

Parameters

n	Index of the row to be returned.
rw	Return Vector for the operation. Must have a length of m_ncols.

Definition at line 195 of file Array.h.

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

Referenced by StFlow::save().

void setColumn	(	size_t	m,
		doublereal *const	col
	)

inline

Set the values in column m to those in array col.

A(i,m) = col(i)

Parameters

m	Column to set
col	pointer to a col vector. Vector must have a length of m_nrows.

Definition at line 209 of file Array.h.

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

void getColumn	(	size_t	m,
		doublereal *const	col
	)

inline

Get the values in column m.

col(i) = A(i,m)

Parameters

m	Column to set
col	pointer to a col vector that will be returned

Definition at line 222 of file Array.h.

References Array2D::m_data, 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