RectangularMatrix< Type > Class Template Reference

A templated 2D rectangular m x n matrix of objects of <Type>. More...

Inheritance diagram for RectangularMatrix< Type >:

Collaboration diagram for RectangularMatrix< Type >:

Public Member Functions
	RectangularMatrix ()
	Null constructor. More...
	RectangularMatrix (const label m, const label n)
	Construct given number of rows and columns,. More...
	RectangularMatrix (const label m, const label n, const Type &)
	Construct with given number of rows and columns. More...
	RectangularMatrix (Istream &)
	Construct from Istream. More...
autoPtr< RectangularMatrix< Type > >	clone () const
	Clone. More...
Public Member Functions inherited from Matrix< RectangularMatrix< Type >, Type >
	Matrix ()
	Null constructor. More...
	Matrix (const label n, const label m)
	Construct given number of rows and columns. More...
	Matrix (const label n, const label m, const Type &)
	Construct with given number of rows and columns. More...
	Matrix (const Matrix< Form, Type > &)
	Copy constructor. More...
	Matrix (Istream &)
	Construct from Istream. More...
autoPtr< Matrix< Form, Type > >	clone () const
	Clone. More...
	~Matrix ()
	Destructor. More...
label	n () const
	Return the number of rows. More...
label	m () const
	Return the number of columns. More...
label	size () const
	Return the number of elements in matrix (n*m) More...
void	checki (const label i) const
	Check index i is within valid range (0 ... n-1). More...
void	checkj (const label j) const
	Check index j is within valid range (0 ... m-1). More...
void	clear ()
	Clear the Matrix, i.e. set sizes to zero. More...
void	transfer (Matrix< Form, Type > &)
	Transfer the contents of the argument Matrix into this Matrix. More...
Form	T () const
	Return the transpose of the matrix. More...
Type *	operator[] (const label)
	Return subscript-checked row of Matrix. More...
const Type *	operator[] (const label) const
	Return subscript-checked row of constant Matrix. More...
void	operator= (const Matrix< Form, Type > &)
	Assignment operator. Takes linear time. More...
void	operator= (const Type &)
	Assignment of all entries to the given value. More...

Additional Inherited Members
Static Public Member Functions inherited from Matrix< RectangularMatrix< Type >, Type >
static const Matrix< Form, Type > &	null ()
	Return a null Matrix. More...

Detailed Description

template<class Type>
class Foam::RectangularMatrix< Type >

A templated 2D rectangular m x n matrix of objects of <Type>.

The matrix dimensions are used for subscript bounds checking etc.

Source files

• RectangularMatrix.H
• RectangularMatrixI.H
• RectangularMatrix.C

Definition at line 52 of file RectangularMatrix.H.

Constructor & Destructor Documentation

RectangularMatrix() [1/4]

RectangularMatrix

inline

Null constructor.

Definition at line 29 of file RectangularMatrixI.H.

RectangularMatrix() [2/4]

RectangularMatrix ( const label  m, const label  n  )

inline

Construct given number of rows and columns,.

Definition at line 36 of file RectangularMatrixI.H.

RectangularMatrix() [3/4]

RectangularMatrix ( const label  m, const label  n, const Type &  t  )

inline

Construct with given number of rows and columns.

and value for all elements.

Definition at line 46 of file RectangularMatrixI.H.

RectangularMatrix() [4/4]

RectangularMatrix ( Istream &  is )

inline

Construct from Istream.

Definition at line 56 of file RectangularMatrixI.H.

Member Function Documentation

clone()

Foam::autoPtr< Foam::RectangularMatrix< Type > > clone

inline

Clone.

Definition at line 63 of file RectangularMatrixI.H.

---

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

• src/OpenFOAM/matrices/RectangularMatrix/RectangularMatrix.H
• src/OpenFOAM/matrices/RectangularMatrix/RectangularMatrixI.H