Input wrapper for Concepts::DenseMatrices. More...
#include <denseIWrapper.hh>
Public Types | |
| typedef concepts::DenseMatrix < Scalar > | MatrixType |
| Type of the resulting matrix. | |
| typedef ArrayDenseWrapper | Type |
Public Member Functions | |
| DenseIWrapper (MatrixType &matrix) | |
| Constructor. | |
| void | get_matrix () |
| Completes the operation. | |
| void | imagType (const MATtype &type) |
| void | isComplex (bool isComplex) |
| void | name (const std::string &) const |
| byte * | pi () |
| byte * | pr () |
| void | realType (const MATtype &type) |
| void | size (const miINT32_t &rows, const miINT32_t &cols) |
Private Types | |
| typedef std::complex< RealScalar > | ComplexScalar |
| typedef NumTraits< Scalar >::Real | RealScalar |
Private Member Functions | |
| template<class Other > | |
| void | copy (bool real=true) |
Private Attributes | |
| miINT32_t | cols_ |
| MATtype | imagType_ |
| bool | isComplex_ |
| MatrixType & | matrix_ |
| bool | matrixPrepared |
| std::string | piCopy_ |
| std::string | prCopy_ |
| MATtype | realType_ |
| miINT32_t | rows_ |
Detailed Description
template<class Scalar>
class concepts::DenseIWrapper< Scalar >
Input wrapper for Concepts::DenseMatrices.
Wrapper for complex or Real concepts::DenseMatrix but works only with column-major matrices with 32-bit indices starting from zero.
This is a template wrapper: you must explicitely express the requested scalar type as template parameter. The resulting matrix will contain that specified type of data independently of the actual data type stored in the MAT-file. If these types match, and the matrix is real, the performance of the wrapper will be very good; otherwise, a relatively slow copy operation will be performed, resulting in a lost of performance.
Note that if the given scalar type is not complex, only the real part of the matrix will be read and copied. The imaginary part won't be read. Vice versa, if that scalar is complex, but the stored matrix is real, the imaginary part of the resulting matrix will be zero.
Definition at line 30 of file denseIWrapper.hh.
Member Typedef Documentation
typedef std::complex<RealScalar> concepts::DenseIWrapper< Scalar >::ComplexScalar [private] |
Definition at line 44 of file denseIWrapper.hh.
| typedef concepts::DenseMatrix<Scalar> concepts::DenseIWrapper< Scalar >::MatrixType |
Type of the resulting matrix.
Constructor needs such type.
Definition at line 40 of file denseIWrapper.hh.
typedef NumTraits<Scalar>::Real concepts::DenseIWrapper< Scalar >::RealScalar [private] |
Definition at line 43 of file denseIWrapper.hh.
| typedef ArrayDenseWrapper concepts::DenseIWrapper< Scalar >::Type |
Definition at line 34 of file denseIWrapper.hh.
Constructor & Destructor Documentation
| concepts::DenseIWrapper< Scalar >::DenseIWrapper | ( | MatrixType & | matrix | ) | [inline] |
Constructor.
The constructor take as argument a reference to a matrix, which will be filled with the data of the MAT-file. You have to construct the matrix before the construction of this wrapper and ensure that it will exist until the input operation reaches the end.
The matrix will be automatically resized and all data inside the matrix will be overwritten and lost.
Definition at line 70 of file denseIWrapper.hh.
Member Function Documentation
| void concepts::DenseIWrapper< Scalar >::copy | ( | bool | real = true | ) | [inline, private] |
Definition at line 115 of file denseIWrapper.hh.
| void concepts::DenseIWrapper< Scalar >::get_matrix | ( | ) | [inline] |
Completes the operation.
During the actual operation, some data can be directly written on the matrix, while other data can be stored elsewhere and wait until the end of the operation.
Please make sure to call this method after the read operation (i.e. after InputDevice::readArray) and before any other operation on the matrix.
This method does not return anything, it just prepares the matrix by writing any temporary information.
Definition at line 150 of file denseIWrapper.hh.
| void concepts::DenseIWrapper< Scalar >::imagType | ( | const MATtype & | type | ) | [inline] |
Definition at line 103 of file denseIWrapper.hh.
| void concepts::DenseIWrapper< Scalar >::isComplex | ( | bool | isComplex | ) | [inline] |
Definition at line 72 of file denseIWrapper.hh.
| void concepts::DenseIWrapper< Scalar >::name | ( | const std::string & | ) | const [inline] |
Definition at line 87 of file denseIWrapper.hh.
| byte* concepts::DenseIWrapper< Scalar >::pi | ( | ) | [inline] |
| byte* concepts::DenseIWrapper< Scalar >::pr | ( | ) | [inline] |
| void concepts::DenseIWrapper< Scalar >::realType | ( | const MATtype & | type | ) | [inline] |
Definition at line 89 of file denseIWrapper.hh.
| void concepts::DenseIWrapper< Scalar >::size | ( | const miINT32_t & | rows, |
| const miINT32_t & | cols | ||
| ) | [inline] |
Definition at line 76 of file denseIWrapper.hh.
Member Data Documentation
miINT32_t concepts::DenseIWrapper< Scalar >::cols_ [private] |
Definition at line 49 of file denseIWrapper.hh.
MATtype concepts::DenseIWrapper< Scalar >::imagType_ [private] |
Definition at line 48 of file denseIWrapper.hh.
bool concepts::DenseIWrapper< Scalar >::isComplex_ [private] |
Definition at line 47 of file denseIWrapper.hh.
MatrixType& concepts::DenseIWrapper< Scalar >::matrix_ [private] |
Definition at line 52 of file denseIWrapper.hh.
bool concepts::DenseIWrapper< Scalar >::matrixPrepared [private] |
Definition at line 53 of file denseIWrapper.hh.
std::string concepts::DenseIWrapper< Scalar >::piCopy_ [private] |
Definition at line 56 of file denseIWrapper.hh.
std::string concepts::DenseIWrapper< Scalar >::prCopy_ [private] |
Definition at line 56 of file denseIWrapper.hh.
MATtype concepts::DenseIWrapper< Scalar >::realType_ [private] |
Definition at line 48 of file denseIWrapper.hh.
miINT32_t concepts::DenseIWrapper< Scalar >::rows_ [private] |
Definition at line 49 of file denseIWrapper.hh.
The documentation for this class was generated from the following file:
- matfile/denseIWrapper.hh