mexmat

Thin wrapper to access Matlab's external interface (MEX). The library is header only and does not require compilation.

The current build system will look for any *_mex.cc files and link them with Matlab's libraries. See the directory 'test/' for example programs. This make file was written for linux.

Quick Start

You can wrap an existing mxArray* with

#include "mexmat.h"
  void mexFunction(int nlhs, mxArray* plhs[], int nrhs, mxArray const* prhs[])
  {
    const mex::Mat<double>(prhs[0]);
  }

Note, it is recommended to add a 'const' qualifier when wrapping a 'const' pointer. This way the array will not be inadvertently modified.

NOTE: there is no way in C++ that I know of to force the wrapped object to be 'const' at compile time.

If the underlying type mxArray does not match the template type of the wrapper, you will get an error. This ensures you get the right type in mex and you will not have to deal with segfaults due to wrong types.

This design choice was intentional. The point of mex is to speed up some loops in Matlab. If Matlab is your primary language for the task, then you must be more concerned with correctness of implementation than other features.

You can also create your own matrix

  mex::Mat<float> M(3,5);

Memory for this class will be managed internally. If you would like to return the variable back to Matlab, you will have to 'release' it. E.g.:

     plhs[0] = my_mat.release();

Otherwise, the array data will be destroyed at the end of the object's life.

using mex::ClassHandle

This allows you to wrap a C++ class and call it from Matlab. The idea to create a pointer to the class and lock it in memory so that Matlab will not delete it upon exit from mexFunction.

You will need to explicitly ask Matlab to dispose of the object once you are done using it.

See the class example in `test/test_class_mex.cc'

We recommend that you wrap your access to the class with another Matlab class. This way everything is transparent to the user.

NOTE IMPORTANT the Matlab class than you want to use to access the C++ pointer must inherit from Matlab's 'handle' base class. This makes the class 'by

Acknowlegments

 This code release was made possible by NPRP grant # 09-980-2-380 from the Qatar
 National Research Fund (a member of Qatar Foundation). The statements made
 herein are solely the responsibility of the author[s].

Contributions:

• Brett Browing
• Muhammad Emad
• Peter Hansen