Easier MATLAB and C++ Integration
C++
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
mexcpp.h
mexcpp_test.cpp

README.md

MEX Without Tears!

mexcpp provides C++ classes to wrap MATLAB objects. The goal is to make writing MEX files less painful.

This is the only library I know of that wraps cell and structure arrays, N-dimensional arrays, and sparse matrices (forthcoming), which are significantly more painful to deal with than plain numeric vectors. If you know about [Rcpp] 1 or [nr3matlab.h] 2, this library is similar, but covers MATLAB's API more completely.

The classes are fully templatized, do not copy memory, and do not check bounds unless requested (forthcoming). Therefore, with optimization enabled, the wrapper should add no runtime penalty.

Typechecking (mxGetClassID) is enabled by default, but can be disabled at your choice/risk if you need the performance.

Since storage models for MATLAB matrices are simple, future integration for Eigen and/or Armadillo should not be difficult.

Requirements

This project is in its infancy, but since the basic functionality works, I wanted to share it as soon as possible. You will need a fairly recent C++ compiler and MATLAB installation. I personally use this library with

  • Mac OS X 10.8 with
    • MATLAB R2011b
    • Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)
  • Linux 3.2.0-64 with
    • MATLAB R2012b
    • g++ (Ubuntu/Linaro 4.6.3-1ubuntu5) 4.6.3

Please let me know if you get this working on a different platform, or if you're having trouble.

Usage

To use, just #include "mexcpp.h". For a full list of examples, see mexcpp_test.cpp. Some examples are:

Let pRhs be the input pointer to mexFunction. Then:

  • To wrap a scalar, double d = scalar<double>(pRhs[i])
  • To wrap a matrix, Mat<double> m(pRhs[i])
    • To address by linear index, double x = m[3]
    • To address by subscript, double y = m(1, 2)
  • Homogeneous cell arrays are currently supported. If we have a cell array of double matrices (all of which could have different dimensions), CellMat<Mat<double> > cm(pRhs[i])
    • To get the linear entry i, auto entry = cm[i] and entry has type Mat<double>. Subscript indexing is also supported, as with all other matrices.
    • The cell array template can take any type, so you can have cell arrays of cell arrays of structure arrays with CellMat<CellMat<StructMat> > > nestedCM
  • Structure arrays can be indexed like auto m = sa(r,c).f<Mat<double> >("m") You can also index a field by number, and an entry in the matrix itself as linear index.