Container for basic information about matrices. More...
#include <MatrixInfo.hh>
Public Member Functions | |
| const std::string & | getBuffer () const |
| Returns the raw data. | |
| miMATRIX_class | getClass () const |
| Returns the class of the matrix. | |
| std::string | getClassString () const |
| Returns the class of the matrix as string. | |
| const std::vector< miINT32_t > & | getDimensions () const |
| Returns the dimensions of the matrix. | |
| const std::string & | getName () const |
| Returns the name of the matrix. | |
| bool | isComplex () const |
| Returns true iff the matrix contains complex elements. | |
Private Attributes | |
| std::string | _buffer |
| miMATRIX_class | _class |
| std::vector< miINT32_t > | _dimensions |
| bool | _isComplex |
| std::string | _name |
Friends | |
| class | InputDevice |
Detailed Description
Container for basic information about matrices.
The MatrixInfo objects hold basic infromation, such as class, flags, name, dimensions for matrices contained in a MAT-file. The InputDevice places for each MAT-file a vector of MatrixInfo objects at disposal representing the matrices of the MAT-file.
Definition at line 30 of file MatrixInfo.hh.
Member Function Documentation
| const std::string& MatrixInfo::getBuffer | ( | ) | const [inline] |
Returns the raw data.
The raw data is the sequence of bytes in which the matrix is stored in the MAT-file. The buffer is interpreted by the InputDevice and the used should not use it.
Definition at line 98 of file MatrixInfo.hh.
| miMATRIX_class MatrixInfo::getClass | ( | ) | const [inline] |
Returns the class of the matrix.
The matrix class is an integer representing the class. The class says how the data is structured, but not the type in which it is stored.
Definition at line 46 of file MatrixInfo.hh.
| std::string MatrixInfo::getClassString | ( | ) | const [inline] |
Returns the class of the matrix as string.
Returns the class as associated string instead of number.
Definition at line 55 of file MatrixInfo.hh.
| const std::vector<miINT32_t>& MatrixInfo::getDimensions | ( | ) | const [inline] |
Returns the dimensions of the matrix.
In case of common, two-dimensional matrices, this method returns a vector containing two items: the number of rows and the number of columns, in this order. Matrices with more than two dimensions are not yet supported by matfile.
Definition at line 75 of file MatrixInfo.hh.
| const std::string& MatrixInfo::getName | ( | ) | const [inline] |
Returns the name of the matrix.
The name of the matrix is the name which it assumes in Matlab or Octave. This name is stored in the MAT-file and can be also used inside the C++ application. The name is the only method for requesting a matrix through the InputDevice::readArray method.
Definition at line 87 of file MatrixInfo.hh.
| bool MatrixInfo::isComplex | ( | ) | const [inline] |
Returns true iff the matrix contains complex elements.
The matrix is considered complex if it has the flag "complex" set to 1.
Definition at line 64 of file MatrixInfo.hh.
Friends And Related Function Documentation
friend class InputDevice [friend] |
Definition at line 31 of file MatrixInfo.hh.
Member Data Documentation
std::string MatrixInfo::_buffer [private] |
Definition at line 38 of file MatrixInfo.hh.
miMATRIX_class MatrixInfo::_class [private] |
Definition at line 34 of file MatrixInfo.hh.
std::vector<miINT32_t> MatrixInfo::_dimensions [private] |
Definition at line 36 of file MatrixInfo.hh.
bool MatrixInfo::_isComplex [private] |
Definition at line 35 of file MatrixInfo.hh.
std::string MatrixInfo::_name [private] |
Definition at line 37 of file MatrixInfo.hh.
The documentation for this struct was generated from the following file:
- matfile/matfile_concepts/src/MatrixInfo.hh