BaseMatrix Class Reference

a data structure to represent a point of departure for constructing a matrix by modifying parts of a previously defined matrix More...

#include <OSMatrix.h>

Inheritance diagram for BaseMatrix:
Inheritance graph
[legend]
Collaboration diagram for BaseMatrix:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BaseMatrix ()
 Standard constructor and destructor methods.
 ~BaseMatrix ()
virtual
ENUM_MATRIX_CONSTRUCTOR_TYPE 
getNodeType ()
virtual std::string getNodeName ()
virtual ENUM_MATRIX_TYPE getMatrixType ()
virtual std::string getMatrixNodeInXML ()
virtual bool alignsOnBlockBoundary (int firstRow, int firstColumn, int nRows, int nCols)
 Check whether a submatrix aligns with the block partition of a matrix or block or other constructor.
virtual BaseMatrixcloneMatrixNode ()
 The implementation of the virtual functions.
bool IsEqual (BaseMatrix *that)
 A function to check for the equality of two objects.

Public Attributes

int baseMatrixIdx
 the index of the base matrix
OSMatrixbaseMatrix
 a pointer to the base matrix
int targetMatrixFirstRow
 to pinpoint the position of the upper left corner of the base matrix within the target matrix
int targetMatrixFirstCol
int baseMatrixStartRow
 to select the position of the upper left corner of the portion of the base matrix that is to be selected
int baseMatrixStartCol
int baseMatrixEndRow
 to select the position of the lower right corner of the portion of the base matrix that is to be selected
int baseMatrixEndCol
bool baseTranspose
 to allow the base matrix to be transposed before it is attached to the target matrix
double scalarMultiplier
 to allow the base matrix to be scaled before it is attached to the target matrix

Detailed Description

a data structure to represent a point of departure for constructing a matrix by modifying parts of a previously defined matrix

Definition at line 1536 of file OSMatrix.h.


Constructor & Destructor Documentation

BaseMatrix::BaseMatrix (  ) 

Standard constructor and destructor methods.

---------- Methods for class BaseMatrix ----------

Definition at line 3909 of file OSMatrix.cpp.

BaseMatrix::~BaseMatrix (  ) 

Definition at line 3927 of file OSMatrix.cpp.


Member Function Documentation

ENUM_MATRIX_CONSTRUCTOR_TYPE BaseMatrix::getNodeType (  )  [virtual]
Returns:
the value of nType

Reimplemented from MatrixNode.

Definition at line 3934 of file OSMatrix.cpp.

std::string BaseMatrix::getNodeName (  )  [virtual]
Returns:
the name of the operator

Implements MatrixNode.

Definition at line 3939 of file OSMatrix.cpp.

ENUM_MATRIX_TYPE BaseMatrix::getMatrixType (  )  [virtual]
Returns:
the type of the matrix elements

Implements MatrixNode.

Definition at line 3944 of file OSMatrix.cpp.

std::string BaseMatrix::getMatrixNodeInXML (  )  [virtual]

The following method writes a matrix node in OSgL format. it is used by OSgLWriter to write a <matrix> element.

Returns:
the MatrixNode and its children as an OSgL string.

Implements MatrixNode.

Definition at line 3949 of file OSMatrix.cpp.

bool BaseMatrix::alignsOnBlockBoundary ( int  firstRow,
int  firstColumn,
int  nRows,
int  nCols 
) [virtual]

Check whether a submatrix aligns with the block partition of a matrix or block or other constructor.

Parameters:
firstRow gives the number of the first row in the submatrix (zero-based)
firstColumn gives the number of the first column in the submatrix (zero-based)
nRows gives the number of rows in the submatrix
nColumns gives the number of columns in the submatrix
Returns:
true if the submatrix aligns with the boundaries of a block

Implements MatrixNode.

Definition at line 3974 of file OSMatrix.cpp.

BaseMatrix * BaseMatrix::cloneMatrixNode (  )  [virtual]

The implementation of the virtual functions.

Returns:
a pointer to a new MatrixNode of the proper type.

Implements MatrixNode.

Definition at line 3979 of file OSMatrix.cpp.

bool BaseMatrix::IsEqual ( BaseMatrix that  )  [virtual]

A function to check for the equality of two objects.

Reimplemented from MatrixNode.

Definition at line 3986 of file OSMatrix.cpp.


Member Data Documentation

the index of the base matrix

Definition at line 1542 of file OSMatrix.h.

a pointer to the base matrix

Definition at line 1547 of file OSMatrix.h.

to pinpoint the position of the upper left corner of the base matrix within the target matrix

Definition at line 1552 of file OSMatrix.h.

Definition at line 1553 of file OSMatrix.h.

to select the position of the upper left corner of the portion of the base matrix that is to be selected

Definition at line 1559 of file OSMatrix.h.

Definition at line 1560 of file OSMatrix.h.

to select the position of the lower right corner of the portion of the base matrix that is to be selected

Definition at line 1566 of file OSMatrix.h.

Definition at line 1567 of file OSMatrix.h.

to allow the base matrix to be transposed before it is attached to the target matrix

Definition at line 1572 of file OSMatrix.h.

to allow the base matrix to be scaled before it is attached to the target matrix

Definition at line 1577 of file OSMatrix.h.


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

Generated on 5 Jul 2015 by  doxygen 1.6.1