NiHu  2.0
NiHu::mex::matrix_base Class Reference

base class of a Matlab mex matrix More...

#include <mex_matrix_separate.hpp>

Public Member Functions

size_t rows (void) const
 return number of rows More...
 
size_t cols (void) const
 return number of columns More...
 

Protected Member Functions

 matrix_base (size_t rows, size_t cols)
 output matrix constructor More...
 
 matrix_base (mxArray const *input)
 input matrix constructor More...
 

Protected Attributes

size_t m_rows
 number of rows
 
size_t m_cols
 number of columns
 

Detailed Description

base class of a Matlab mex matrix

Definition at line 51 of file mex_matrix_separate.hpp.

Constructor & Destructor Documentation

◆ matrix_base() [1/2]

NiHu::mex::matrix_base::matrix_base ( size_t  rows,
size_t  cols 
)
inlineprotected

output matrix constructor

used when a new matrix is created in C++ and passed to Matlab

Parameters
[in]rowsnumber of rows
[in]colsnumber of columns

Definition at line 59 of file mex_matrix_separate.hpp.

◆ matrix_base() [2/2]

NiHu::mex::matrix_base::matrix_base ( mxArray const *  input)
inlineprotected

input matrix constructor

used when an input matrix is received from Matlab

Parameters
[in]inputthe Matlab pointer to the matrix

Definition at line 68 of file mex_matrix_separate.hpp.

Member Function Documentation

◆ cols()

size_t NiHu::mex::matrix_base::cols ( void  ) const
inline

return number of columns

Returns
the number of columns

Definition at line 86 of file mex_matrix_separate.hpp.

◆ rows()

size_t NiHu::mex::matrix_base::rows ( void  ) const
inline

return number of rows

Returns
the number of rows

Definition at line 78 of file mex_matrix_separate.hpp.


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