NiHu::mex::complex_matrix< T > Class Template Reference

Container class of a complex matrix stored in Matlab format. More...

#include <mex_matrix_separate.hpp>

Public Types
typedef T	scalar_t
	the real scalar type

Public Member Functions
	complex_matrix (size_t rows, size_t cols, mxArray *&output)
	output matrix (allocating) constructor More...
	complex_matrix (mxArray const *input)
	input matrix constructor More...
std::complex< scalar_t >	operator() (size_t row, size_t col) const
	index operator that returns a complex number More...
index_proxy< complex_matrix >	operator() (size_t row, size_t col)
	index operator that returns a proxy More...
Public Member Functions inherited from NiHu::mex::matrix_base
size_t	rows (void) const
	return number of rows More...
size_t	cols (void) const
	return number of columns More...

Protected Attributes
scalar_t *	m_real
	array of real data
scalar_t *	m_imag
	array of imaginary data
Protected Attributes inherited from NiHu::mex::matrix_base
size_t	m_rows
	number of rows
size_t	m_cols
	number of columns

Friends
class	index_proxy< complex_matrix< T > >

Additional Inherited Members
Protected Member Functions inherited from NiHu::mex::matrix_base
	matrix_base (size_t rows, size_t cols)
	output matrix constructor More...
	matrix_base (mxArray const *input)
	input matrix constructor More...

Detailed Description

template<class T>
class NiHu::mex::complex_matrix< T >

Container class of a complex matrix stored in Matlab format.

Definition at line 256 of file mex_matrix_separate.hpp.

Constructor & Destructor Documentation

complex_matrix() [1/2]

template<class T >

NiHu::mex::complex_matrix< T >::complex_matrix ( size_t  rows, size_t  cols, mxArray *&  output  )

inline

output matrix (allocating) constructor

Parameters

[in]	rows	number of rows
[in]	cols	number of columns
[out]	output	pointer to the result matrix is copied here

Definition at line 269 of file mex_matrix_separate.hpp.

complex_matrix() [2/2]

template<class T >

NiHu::mex::complex_matrix< T >::complex_matrix ( mxArray const *  input )

inline

input matrix constructor

Parameters

[in]

input

pointer to the native Matlab matrix format

Definition at line 281 of file mex_matrix_separate.hpp.

Member Function Documentation

operator()() [1/2]

template<class T >

index_proxy<complex_matrix> NiHu::mex::complex_matrix< T >::operator() ( size_t  row, size_t  col  )

inline

index operator that returns a proxy

Parameters

row	row index
col	column index

Returns

proxy object storing the parent container and the indices

Definition at line 304 of file mex_matrix_separate.hpp.

operator()() [2/2]

template<class T >

std::complex<scalar_t> NiHu::mex::complex_matrix< T >::operator() ( size_t  row, size_t  col  ) const

inline

index operator that returns a complex number

Parameters

row	row index
col	column index

Returns

complex number

Definition at line 293 of file mex_matrix_separate.hpp.

---

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

• src/util/mex_matrix_separate.hpp