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. More...

typedef vector_fp::const_iterator	const_iterator
	Type definition for the const_iterator class that is can be used by Array2D types. More...

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

	Array2D (const size_t m, const size_t n, const doublereal v=0.0)
	Constructor. More...

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

	Array2D (const Array2D &y)
	Copy constructor. More...

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

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

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

void	appendColumn (const vector_fp &c)
	Append a column to the existing matrix using a std vector. More...

void	appendColumn (const doublereal *const c)
	Append a column to the existing matrix. More...

void	setRow (size_t n, const doublereal *const rw)
	Set the nth row to array rw. More...

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

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

void	getColumn (size_t m, doublereal *const col)
	Get the values in column m. More...

virtual	~Array2D ()
	Destructor. More...

void	axpy (doublereal a, const Array2D &x, const Array2D &y)
	Evaluate z = a*x + y. More...

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

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

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

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

doublereal	value (size_t i, size_t j) const
	Returns the value of a single matrix entry. More...

size_t	nRows () const
	Number of rows. More...

size_t	nColumns () const
	Number of columns. More...

iterator	begin ()
	Return an iterator pointing to the first element. More...

iterator	end ()
	Return an iterator pointing past the last element. More...

const_iterator	begin () const
	Return a const iterator pointing to the first element. More...

const_iterator	end () const
	Return a const iterator pointing to past the last element. More...

vector_fp &	data ()
	Return a reference to the data vector. More...

const vector_fp &	data () const
	Return a const reference to the data vector. More...

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

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

Protected Attributes
vector_fp	m_data
	Data stored in a single array. More...

size_t	m_nrows
	Number of rows. More...

size_t	m_ncols
	Number of columns. More...

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 29 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 37 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 44 of file Array.h.

Constructor & Destructor Documentation

Array2D ( )

inline

Default constructor.

Create an empty array.

Definition at line 49 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 64 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 80 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 90 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 227 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 104 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 121 of file Array.h.

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

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

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

Deprecated:: To be removed after Cantera 2.2.

Definition at line 133 of file Array.h.

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

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 147 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 164 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 178 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 190 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 204 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 217 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