Mexfiles

Conversions between IT++ and Matlab for writing mex-files. More...

## Functions

bin | itpp::mxArray2bin (const mxArray *in)
| Convert the matlab-format mxArray to bin.
short | itpp::mxArray2short (const mxArray *in)
| Convert the matlab-format mxArray to short.
int | itpp::mxArray2int (const mxArray *in)
| Convert the matlab-format mxArray to int.
double | itpp::mxArray2double (const mxArray *in)
| Convert the matlab-format mxArray to double.
std::complex< double > | itpp::mxArray2double_complex (const mxArray *in)
| Convert the matlab-format mxArray to complex<double>
std::string | itpp::mxArray2string (const mxArray *in)
| Convert the matlab-format mxArray to string.
bvec | itpp::mxArray2bvec (const mxArray *in)
| Convert the matlab-format mxArray to bvec.
svec | itpp::mxArray2svec (const mxArray *in)
| Convert the matlab-format mxArray to svec.
ivec | itpp::mxArray2ivec (const mxArray *in)
| Convert the matlab-format mxArray to ivec.
vec | itpp::mxArray2vec (const mxArray *in)
| Convert the matlab-format mxArray to vec.
cvec | itpp::mxArray2cvec (const mxArray *in)
| Convert the matlab-format mxArray to cvec.
bmat | itpp::mxArray2bmat (const mxArray *in)
| Convert the matlab-format mxArray to bmat.
smat | itpp::mxArray2smat (const mxArray *in)
| Convert the matlab-format mxArray to smat.
imat | itpp::mxArray2imat (const mxArray *in)
| Convert the matlab-format mxArray to imat.
mat | itpp::mxArray2mat (const mxArray *in)
| Convert the matlab-format mxArray to mat.
cmat | itpp::mxArray2cmat (const mxArray *in)
| Convert the matlab-format mxArray to cmat.
void | itpp::bin2mxArray (const bin &in, mxArray *out)
| Convert bin to the matlab-format mxArray.
void | itpp::short2mxArray (const short &in, mxArray *out)
| Convert short to the matlab-format mxArray.
void | itpp::int2mxArray (const int &in, mxArray *out)
| Convert int to the matlab-format mxArray.
void | itpp::double2mxArray (const double &in, mxArray *out)
| Convert double to the matlab-format mxArray.
void | itpp::double_complex2mxArray (const std::complex< double > &in, mxArray *out)
| Convert complex<double> to the matlab-format mxArray.
void | itpp::string2mxArray (const std::string &in, mxArray *&out)
| Convert string to the matlab-format mxArray.
void | itpp::bvec2mxArray (const bvec &in, mxArray *out)
| Convert bvec to the matlab-format mxArray.
void | itpp::svec2mxArray (const svec &in, mxArray *out)
| Convert svec to the matlab-format mxArray.
void | itpp::ivec2mxArray (const ivec &in, mxArray *out)
| Convert ivec to the matlab-format mxArray.
void | itpp::vec2mxArray (const vec &in, mxArray *out)
| Convert vec to the matlab-format mxArray.
void | itpp::cvec2mxArray (const cvec &in, mxArray *out)
| Convert cvec to the matlab-format mxArray.
void | itpp::bmat2mxArray (const bmat &in, mxArray *out)
| Convert bmat to the matlab-format mxArray.
void | itpp::smat2mxArray (const smat &in, mxArray *out)
| Convert smat to the matlab-format mxArray.
void | itpp::imat2mxArray (const imat &in, mxArray *out)
| Convert imat to the matlab-format mxArray.
void | itpp::mat2mxArray (const mat &in, mxArray *out)
| Convert mat to the matlab-format mxArray.
void | itpp::cmat2mxArray (const cmat &in, mxArray *out)
| Convert cmat to the matlab-format mxArray.
void | itpp::mxArray2Csvec (const mxArray *in, short *out)
| Convert the matlab-format mxArray to C-format pointer to short.
void | itpp::mxArray2Civec (const mxArray *in, int *out)
| Convert the matlab-format mxArray to C-format pointer to int.
void | itpp::mxArray2Cvec (const mxArray *in, double *out)
| Convert the matlab-format mxArray to C-format pointer to double.
void | itpp::mxArray2Ccvec (const mxArray *in, double *out_real, double *out_imag)
| Convert the matlab-format mxArray to C-format pointers to double (real and imaginary parts)
void | itpp::mxArray2Csmat (const mxArray *in, short **out)
| Convert the matlab-format mxArray to C-format pointer to pointer to short.
void | itpp::mxArray2Cimat (const mxArray *in, int **out)
| Convert the matlab-format mxArray to C-format pointer to pointer to int.
void | itpp::mxArray2Cmat (const mxArray *in, double **out)
| Convert the matlab-format mxArray to C-format pointer to pointer to double.
void | itpp::mxArray2Ccmat (const mxArray *in, double **out_real, double **out_imag)
| Convert the matlab-format mxArray to C-format pointer to pointer to double (real and imaginary parts)
void | itpp::Csvec2mxArray (short *in, mxArray *out)
| Convert C-format pointer to short to matlab-format mxArray.
void | itpp::Civec2mxArray (int *in, mxArray *out)
| Convert C-format pointer to int to matlab-format mxArray.
void | itpp::Cvec2mxArray (double *in, mxArray *out)
| Convert C-format pointer to double to matlab-format mxArray.
void | itpp::Ccvec2mxArray (double *in_real, double *in_imag, mxArray *out)
| Convert C-format pointers to double (real and imaginary parts) to matlab-format mxArray.
void | itpp::Csmat2mxArray (short **in, mxArray *out)
| Convert C-format pointer to pointer to short to matlab-format mxArray.
void | itpp::Cimat2mxArray (int **in, mxArray *out)
| Convert C-format pointer to pointer to int to matlab-format mxArray.
void | itpp::Cmat2mxArray (double **in, mxArray *out)
| Convert C-format pointer to pointer to double to matlab-format mxArray.
void | itpp::Ccmat2mxArray (double **in_real, double **in_imag, mxArray *out)
| Convert C-format pointer to pointer to double (real and imaginary parts) to matlab-format mxArray.

## Detailed Description

Conversions between IT++ and Matlab for writing mex-files.

Author
  Tony Ottosson and Pal Frenger

These routines are used to help writng mex-files for speeding up matlab simulations. A simple mex-file that performs QPSK modulation is given below.

#include <itpp/itcomm.h>
#include <itpp/itmex.h>
using namespace itpp;
void mexFunction(int n_output, mxArray *output[], int n_input, const mxArray *input[])
{
// Check the number of inputs and output arguments
if(n_output!=1) mexErrMsgTxt("Wrong number of output variables!");
if(n_input!=1) mexErrMsgTxt("Wrong number of input variables!");
// Convert input variables to IT++ format
bvec input_bits = mxArray2bvec(input[0]);
// ------------------ Start of routine ---------------------------
cvec output_symbols;
QPSK qpsk;
output_symbols = qpsk.modulate_bits(input_bits);
// ------------------ End of routine -----------------------------
// Create output vectors
output[0] = mxCreateDoubleMatrix(1,output_symbols.size(), mxCOMPLEX);
// Convert the IT++ format to Matlab format for output
cvec2mxArray(output_symbols, output[0]);
}
itpp::Array
General array class.
Definition array.h:105
itpp::Array::size
int size() const
Returns the number of data elements in the array object.
Definition array.h:155
itpp::QPSK
QPSK modulator.
Definition modulator.h:678
itpp::mxArray2bvec
bvec mxArray2bvec(const mxArray *in)
Convert the matlab-format mxArray to bvec.
Definition itmex.h:292
itpp::cvec2mxArray
void cvec2mxArray(const cvec &in, mxArray *out)
Convert cvec to the matlab-format mxArray.
Definition itmex.h:586
itcomm.h
Include file for the IT++ communications module.
itmex.h
Conversion routines between IT++ and Matlab.
itpp
itpp namespace
Definition itmex.h:37

## Function Documentation

## mxArray2bin()

bin itpp::mxArray2bin | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to bin.

Definition at line 215 of file itmex.h.

References itpp::size().

## mxArray2short()

short itpp::mxArray2short | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to short.

Definition at line 226 of file itmex.h.

References itpp::size().

## mxArray2int()

int itpp::mxArray2int | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to int.

Definition at line 237 of file itmex.h.

References itpp::size().

## mxArray2double()

double itpp::mxArray2double | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to double.

Definition at line 248 of file itmex.h.

References itpp::size().

## mxArray2double_complex()

std::complex< double > itpp::mxArray2double_complex | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to complex<double>

Definition at line 259 of file itmex.h.

References itpp::size().

## mxArray2string()

std::string itpp::mxArray2string | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to string.

Definition at line 282 of file itmex.h.

References itpp::Array< T >::data.

## mxArray2bvec()

bvec itpp::mxArray2bvec | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to bvec.

Definition at line 292 of file itmex.h.

References itpp::Array< T >::set_size(), and itpp::size().

## mxArray2svec()

svec itpp::mxArray2svec | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to svec.

Definition at line 312 of file itmex.h.

References itpp::Array< T >::set_size(), and itpp::size().

## mxArray2ivec()

ivec itpp::mxArray2ivec | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to ivec.

Definition at line 332 of file itmex.h.

References itpp::Array< T >::set_size(), and itpp::size().

## mxArray2vec()

vec itpp::mxArray2vec | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to vec.

Definition at line 352 of file itmex.h.

References itpp::Array< T >::set_size(), and itpp::size().

## mxArray2cvec()

cvec itpp::mxArray2cvec | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to cvec.

Definition at line 372 of file itmex.h.

References itpp::Array< T >::set_size(), and itpp::size().

## mxArray2bmat()

bmat itpp::mxArray2bmat | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to bmat.

Definition at line 400 of file itmex.h.

References itpp::Array< T >::set_size().

## mxArray2smat()

smat itpp::mxArray2smat | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to smat.

Definition at line 424 of file itmex.h.

References itpp::Array< T >::set_size().

## mxArray2imat()

imat itpp::mxArray2imat | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to imat.

Definition at line 448 of file itmex.h.

References itpp::Array< T >::set_size().

## mxArray2mat()

mat itpp::mxArray2mat | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to mat.

Definition at line 471 of file itmex.h.

References itpp::Array< T >::set_size().

## mxArray2cmat()

cmat itpp::mxArray2cmat | ( | const mxArray * | in | ) |

Convert the matlab-format mxArray to cmat.

Definition at line 494 of file itmex.h.

References itpp::Array< T >::set_size().

## double2mxArray()

void itpp::double2mxArray | ( | const double & | in,
|  | mxArray * | out
| ) |  |

Convert double to the matlab-format mxArray.

Definition at line 523 of file itmex.h.

## double_complex2mxArray()

void itpp::double_complex2mxArray | ( | const std::complex< double > & | in,
|  | mxArray * | out
| ) |  |

Convert complex<double> to the matlab-format mxArray.

Definition at line 531 of file itmex.h.

## string2mxArray()

void itpp::string2mxArray | ( | const std::string & | in,
|  | mxArray *& | out
| ) |  |

Convert string to the matlab-format mxArray.

Definition at line 542 of file itmex.h.

References itpp::Array< T >::data.

## bvec2mxArray()

void itpp::bvec2mxArray | ( | const bvec & | in,
|  | mxArray * | out
| ) |  |

Convert bvec to the matlab-format mxArray.

Definition at line 551 of file itmex.h.

References itpp::Array< T >::size().

## ivec2mxArray()

void itpp::ivec2mxArray | ( | const ivec & | in,
|  | mxArray * | out
| ) |  |

Convert ivec to the matlab-format mxArray.

Definition at line 564 of file itmex.h.

References itpp::Array< T >::size().

## vec2mxArray()

void itpp::vec2mxArray | ( | const vec & | in,
|  | mxArray * | out
| ) |  |

Convert vec to the matlab-format mxArray.

Definition at line 575 of file itmex.h.

References itpp::Array< T >::size().

## cvec2mxArray()

void itpp::cvec2mxArray | ( | const cvec & | in,
|  | mxArray * | out
| ) |  |

Convert cvec to the matlab-format mxArray.

Definition at line 586 of file itmex.h.

References itpp::Array< T >::size().

## bmat2mxArray()

void itpp::bmat2mxArray | ( | const bmat & | in,
|  | mxArray * | out
| ) |  |

Convert bmat to the matlab-format mxArray.

Definition at line 600 of file itmex.h.

## smat2mxArray()

void itpp::smat2mxArray | ( | const smat & | in,
|  | mxArray * | out
| ) |  |

Convert smat to the matlab-format mxArray.

Definition at line 623 of file itmex.h.

## imat2mxArray()

void itpp::imat2mxArray | ( | const imat & | in,
|  | mxArray * | out
| ) |  |

Convert imat to the matlab-format mxArray.

Definition at line 643 of file itmex.h.

## mat2mxArray()

void itpp::mat2mxArray | ( | const mat & | in,
|  | mxArray * | out
| ) |  |

Convert mat to the matlab-format mxArray.

Definition at line 663 of file itmex.h.

## cmat2mxArray()

void itpp::cmat2mxArray | ( | const cmat & | in,
|  | mxArray * | out
| ) |  |

Convert cmat to the matlab-format mxArray.

Definition at line 683 of file itmex.h.

## mxArray2Csvec()

void itpp::mxArray2Csvec | ( | const mxArray * | in,
|  | short * | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to short.

Definition at line 706 of file itmex.h.

References itpp::size().

## mxArray2Civec()

void itpp::mxArray2Civec | ( | const mxArray * | in,
|  | int * | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to int.

Definition at line 715 of file itmex.h.

References itpp::size().

## mxArray2Cvec()

void itpp::mxArray2Cvec | ( | const mxArray * | in,
|  | double * | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to double.

Definition at line 724 of file itmex.h.

References itpp::size().

## mxArray2Ccvec()

void itpp::mxArray2Ccvec | ( | const mxArray * | in,
|  | double * | out_real,
|  | double * | out_imag
| ) |  |

Convert the matlab-format mxArray to C-format pointers to double (real and imaginary parts)

Definition at line 733 of file itmex.h.

References itpp::size().

## mxArray2Csmat()

void itpp::mxArray2Csmat | ( | const mxArray * | in,
|  | short ** | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to pointer to short.

Definition at line 744 of file itmex.h.

## mxArray2Cimat()

void itpp::mxArray2Cimat | ( | const mxArray * | in,
|  | int ** | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to pointer to int.

Definition at line 760 of file itmex.h.

## mxArray2Cmat()

void itpp::mxArray2Cmat | ( | const mxArray * | in,
|  | double ** | out
| ) |  |

Convert the matlab-format mxArray to C-format pointer to pointer to double.

Definition at line 776 of file itmex.h.

## mxArray2Ccmat()

void itpp::mxArray2Ccmat | ( | const mxArray * | in,
|  | double ** | out_real,
|  | double ** | out_imag
| ) |  |

Convert the matlab-format mxArray to C-format pointer to pointer to double (real and imaginary parts)

Definition at line 792 of file itmex.h.

## Csvec2mxArray()

void itpp::Csvec2mxArray | ( | short * | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to short to matlab-format mxArray.

Definition at line 811 of file itmex.h.

References itpp::size().

## Civec2mxArray()

void itpp::Civec2mxArray | ( | int * | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to int to matlab-format mxArray.

Definition at line 820 of file itmex.h.

References itpp::size().

## Cvec2mxArray()

void itpp::Cvec2mxArray | ( | double * | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to double to matlab-format mxArray.

Definition at line 829 of file itmex.h.

References itpp::size().

## Ccvec2mxArray()

void itpp::Ccvec2mxArray | ( | double * | in_real,
|  | double * | in_imag,
|  | mxArray * | out
| ) |  |

Convert C-format pointers to double (real and imaginary parts) to matlab-format mxArray.

Definition at line 838 of file itmex.h.

References itpp::size().

## Csmat2mxArray()

void itpp::Csmat2mxArray | ( | short ** | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to pointer to short to matlab-format mxArray.

Definition at line 849 of file itmex.h.

## Cimat2mxArray()

void itpp::Cimat2mxArray | ( | int ** | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to pointer to int to matlab-format mxArray.

Definition at line 865 of file itmex.h.

## Cmat2mxArray()

void itpp::Cmat2mxArray | ( | double ** | in,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to pointer to double to matlab-format mxArray.

Definition at line 881 of file itmex.h.

## Ccmat2mxArray()

void itpp::Ccmat2mxArray | ( | double ** | in_real,
|  | double ** | in_imag,
|  | mxArray * | out
| ) |  |

Convert C-format pointer to pointer to double (real and imaginary parts) to matlab-format mxArray.

Definition at line 897 of file itmex.h.

Generated on Mon Jun 10 2024 11:49:31 for IT++ by Doxygen 1.9.8