image thumbnail

mxGetPropertyPtr & mxSetPropertySDC C-mex functions

version 4.1.0.1 (327 KB) by James Tursa
Fast memory efficient alternative to API functions mxGetProperty & mxSetProperty.

1K Downloads

Updated 18 Jun 2019

View License

When The Mathworks® introduced MATLAB® version R2008a they included a new object oriented format called classdef. This addition greatly expanded the object oriented capabilities of MATLAB® at the m-file level. There were also two new mex API functions introduced at that same time: mxGetProperty and mxSetProperty. Unfortunately, both of these functions work with copies of the properties and not the actual properties themselves. So whereas the old-style class variables can easily and efficiently be accessed with the mex API functions mxGetField, mxGetFieldByNumber, mxSetField, and mxSetFieldByNumber since they use pointers to the original properties, there were no equivalent mex API functions provided for the newer classdef classes. This presents a problem for the mex programmer, particularly if the properties in question are large. Using mxGetProperty will significantly slow the routine down and also risk using up valuable heap memory. The same is true for mxSetProperty.
The new mxGetPropertyPtr C-mex function provided in this package solves half of the problem. It returns a pointer to the original property rather than a pointer to a copy of the property. Thus the property can be accessed efficiently inside a mex routine. The other half of the problem is solved by the new mxSetPropertySDC function, which sets a property to a shared data copy of an mxArray.
These functions have been tested on various Win32 and Win64 versions of MATLAB R2009a - R2019a. For R2018a and later you are expected to use the -R2018a option when compiling your mex code with this submission.

Cite As

James Tursa (2021). mxGetPropertyPtr & mxSetPropertySDC C-mex functions (https://www.mathworks.com/matlabcentral/fileexchange/30672-mxgetpropertyptr-mxsetpropertysdc-c-mex-functions), MATLAB Central File Exchange. Retrieved .

MATLAB Release Compatibility
Created with R2008a
Compatible with any release
Platform Compatibility
Windows macOS Linux

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!