Public Member Functions | List of all members
SquareMatrix< Type > Class Template Reference

A templated 2D square matrix of objects of <T>, where the n x n matrix dimension is known and used for subscript bounds checking, etc. More...

Inheritance diagram for SquareMatrix< Type >:
Inheritance graph
[legend]
Collaboration diagram for SquareMatrix< Type >:
Collaboration graph
[legend]

Public Member Functions

 SquareMatrix ()
 Null constructor. More...
 
 SquareMatrix (const label n)
 Construct given number of rows/columns. More...
 
 SquareMatrix (const label m, const label n)
 Construct given number of rows and columns,. More...
 
 SquareMatrix (const label m, const label n, const Type &)
 Construct with given number of rows and rows. More...
 
 SquareMatrix (Istream &)
 Construct from Istream. More...
 
autoPtr< SquareMatrix< Type > > clone () const
 Clone. More...
 
- Public Member Functions inherited from Matrix< SquareMatrix< 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< SquareMatrix< Type >, Type > &)
 Copy constructor. More...
 
 Matrix (Istream &)
 Construct from Istream. More...
 
autoPtr< Matrix< SquareMatrix< Type >, 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< SquareMatrix< Type >, Type > &)
 Transfer the contents of the argument Matrix into this Matrix. More...
 
SquareMatrix< Type > 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< SquareMatrix< Type >, 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< SquareMatrix< Type >, Type >
static const Matrix< SquareMatrix< Type >, Type > & null ()
 Return a null Matrix. More...
 

Detailed Description

template<class Type>
class Foam::SquareMatrix< Type >

A templated 2D square matrix of objects of <T>, where the n x n matrix dimension is known and used for subscript bounds checking, etc.

Source files

Definition at line 51 of file SquareMatrix.H.

Constructor & Destructor Documentation

SquareMatrix ( )
inline

Null constructor.

Definition at line 29 of file SquareMatrixI.H.

Referenced by SquareMatrix< Type >::SquareMatrix().

Here is the caller graph for this function:

SquareMatrix ( const label  n)
inline

Construct given number of rows/columns.

Definition at line 35 of file SquareMatrixI.H.

SquareMatrix ( const label  m,
const label  n 
)
inline

Construct given number of rows and columns,.

It checks that m == n.

Definition at line 41 of file SquareMatrixI.H.

References Foam::exit(), Foam::FatalError, FatalErrorIn, and SquareMatrix< Type >::SquareMatrix().

Here is the call graph for this function:

SquareMatrix ( const label  m,
const label  n,
const Type &  t 
)
inline

Construct with given number of rows and rows.

and value for all elements. It checks that m == n.

Definition at line 56 of file SquareMatrixI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

SquareMatrix ( Istream is)
inline

Construct from Istream.

Definition at line 75 of file SquareMatrixI.H.

Member Function Documentation

Foam::autoPtr< Foam::SquareMatrix< Type > > clone ( ) const
inline

Clone.

Definition at line 82 of file SquareMatrixI.H.


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