Class hierarchy   Compound list   File list   Compound Members   File Members   Related Pages   Examples  

---

baseMatrix Class Reference

The baseMatrix template is the template for a matrix of objects. More...

Inherited by Matrix.

List of all members.

Public Members

• baseMatrix (int = 1, int = 1)

  The default constructor for the template baseMatrix.

• baseMatrix (const baseMatrix &)

  The copy constructor for the template baseMatrix.

• ~baseMatrix ()
• T& operator() (int, int)

  Overloaded () operator, provides access to the baseMatrix elements.

• const T& operator() (int, int) const

  Overloaded () operator, provides access to the baseMatrix elements.

• int getnumberRows () const
• int getnumberColumns () const
• const baseMatrix<T>& operator= (const baseMatrix<T> &)

  Overloaded assignment operator.

• const baseMatrix<T>& operator= (const baseVector<T> &)
• baseVector<T> getRow (int) const
• baseVector<T> getColumn (int) const
• void setRow (int, const baseVector<T> &)
• void setColumn (int, const baseVector<T> &)

Protected Members

• T** ptr
• int numberRows
• int numberColumns

---

Detailed Description

The baseMatrix template is the template for a matrix of objects.

A baseMatrix object created with an instantiation of this template is resizable. The private data of the baseMatrix template consists of:

• int numberRows,
• int numberColumns,
• T **ptr, which represents the elements of the matrix. Note that the elements are stored in a contiguous block of memory, not as a vector of vectors.

Examples:

d1SaddleODE.C and d1StableODE.C.

---

Member Function Documentation

baseMatrix::baseMatrix(int WRows, int WColumns)

The default constructor for the template baseMatrix.

Parameters:

T - the type of elements in the baseMatrix.

WRows - a positive integer specifying the number of rows of the baseMatrix.

WColumns - a positive integer specifying the number of columns of the baseMatrix.

Returns:

a baseMatrix<T> object.

baseMatrix::baseMatrix(const baseMatrix<T> &init)

The copy constructor for the template baseMatrix.

Parameters:

T - the type of elements in the baseMatrix.

init - a reference to a baseMatrix<T> constant object.

Returns:

a baseMatrix<T> object.

const T& baseMatrix::operator()(int row, int column) const

Overloaded () operator, provides access to the baseMatrix elements.

Parameters:

T - the type of elements in the baseMatrix.

row - a positive integer specifying the row of the element to access.

column - a positive integer specifying the column of the element to access.

Returns:

a reference to a T.

const T& baseMatrix::operator()(int row, int column) const

Overloaded () operator, provides access to the baseMatrix elements.

Parameters:

T - the type of elements in the baseMatrix.

row - a positive integer specifying the row of the element to access.

column - a positive integer specifying the column of the element to access.

Returns:

a reference to a T.

const baseMatrix<T>& baseMatrix::operator=(const baseMatrix<T> &right)

Overloaded assignment operator.

Parameters:

T - the type of elements in the baseMatrix.

right - a reference to a baseMatrix<T> constant, on the right side of the equality.

Returns:

a reference to a baseMatrix<T> constant, copied to the left side of the equality.

---

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

• TBaseMatrix.h
• TBaseMatrix.C

---