MatrixElements Class Reference

an abstract class to help represent the elements in a MatrixType object From this we derive concrete classes that are used to store specific types of values, such as constant values, variable references, general nonlinear expressions, etc. More...

#include <OSMatrix.h>

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

List of all members.

Public Member Functions

 MatrixElements ()
 ---------- Methods for class MatrixElements ----------
virtual ~MatrixElements ()
bool getRowMajor ()
 Returns whether the matrix is stored row-wise or column-wise.
bool IsEqual (MatrixElements *that)
 A function to check for the equality of two objects.

Public Attributes

bool rowMajor
 To indicate whether the matrix elements are stored in row major form or column major form.
int numberOfValues
 numberOfValues records the number of entries in the arrays that make up the instance of nonzeros
IntVectorstart
 A vector listing the row or column starts.
IntVectorindex
 The index array of the (nonzero) elements.

Detailed Description

an abstract class to help represent the elements in a MatrixType object From this we derive concrete classes that are used to store specific types of values, such as constant values, variable references, general nonlinear expressions, etc.

Definition at line 248 of file OSMatrix.h.


Constructor & Destructor Documentation

MatrixElements::MatrixElements (  ) 

---------- Methods for class MatrixElements ----------

Definition at line 2838 of file OSMatrix.cpp.

MatrixElements::~MatrixElements (  )  [virtual]

Definition at line 2849 of file OSMatrix.cpp.


Member Function Documentation

bool MatrixElements::getRowMajor (  ) 

Returns whether the matrix is stored row-wise or column-wise.

Definition at line 2880 of file OSMatrix.cpp.

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

A function to check for the equality of two objects.

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.

Reimplemented from MatrixNode.

Reimplemented in ConstantMatrixElements, VarReferenceMatrixElements, LinearMatrixElements, GeneralMatrixElements, ObjReferenceMatrixElements, ConReferenceMatrixElements, and MixedRowReferenceMatrixElements.

Definition at line 2897 of file OSMatrix.cpp.


Member Data Documentation

To indicate whether the matrix elements are stored in row major form or column major form.

Definition at line 255 of file OSMatrix.h.

numberOfValues records the number of entries in the arrays that make up the instance of nonzeros

Definition at line 261 of file OSMatrix.h.

A vector listing the row or column starts.

Definition at line 266 of file OSMatrix.h.

The index array of the (nonzero) elements.

Definition at line 269 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