#include <CapeMatrix.hpp>
Public Member Functions | |
| virtual Common::Types::CapeLong | GetNumRows () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeLong | GetNumCols () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeBoolean | QuerySymmetric () const =0 throw (Common::Error::ECapeUnknown) |
| virtual CapeMatrixOrdering | QueryOrdering () const =0 throw (Common::Error::ECapeUnknown) |
| virtual CapeMatrixType | QueryType () const =0 throw (Common::Error::ECapeUnknown) |
| virtual const Common::Types::CapeArrayDouble & | GetValues () const =0 throw (Common::Error::ECapeUnknown) |
Detailed Description
CapeOpen base matrix class.
Member Function Documentation
| virtual Common::Types::CapeLong GetNumCols | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the number of columns in a matrix.
| virtual Common::Types::CapeLong GetNumRows | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the number of rows in a matrix.
| virtual const Common::Types::CapeArrayDouble& GetValues | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
This method returns an array of double values in all cases. The semantics depend on the subtype, symmetry and ordering (see QueryType and QueryOrdering).
| virtual CapeMatrixOrdering QueryOrdering | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
For unsymmetric matrices, some subtypes can return their values ordered either "by row" or "by column". This method indicates which type is used. The value returned is a CapeOpen type with three values CAPE_ROW, CAPE_COLUMN, CAPE_OTHER. (CAPE_OTHER is for symmetric matrices where CAPE_ROW or CAPE_COLUMN gives the same result, or unstructured matrices where values are returned depending on the information given by GetStructure).
| virtual Common::Types::CapeBoolean QuerySymmetric | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Returns TRUE if this is a symmetric matrix, FALSE otherwise. Note that NumRows must equal NumCols if this matrix is symmetric.
| virtual CapeMatrixType QueryType | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
This method indicates which subtype is this matrix. The value returned is a CapeOpen enumerated type with three values (FULL, UNSTRUCTURED and BANDED). This allows the subtype of the matrix to be determined without trial and error.
The documentation for this class was generated from the following file:
