matlab-sys provides low level bindings to Matlabs C API to allow writing MEX functions in Rust while using the C Matrix API and interacting with the C MAT API.
To make use of the functionality provided by this crate it has to be linked against the library files 'libmex.lib', 'libmx.lib' and 'libmat.lib' provided by your installation of Matlab. To find these libraries define the environment variable 'MATLABPATH' with the path to your Matlab installation as its value.
To build a mex function in Rust the crate type has to be 'cdylib', so a dynamic link library. The entry point for a mex function is a function with the signature ```
pub unsafe extern "C" fn mexFunction( nlhs: cint, plhs: *mut *mut mxArray, nrhs: cint, prhs: *const *const mxArray, ) ``` For an example of how to write a mex function using this crate look into the mex-examples directory. After building the build artifact can simply be renamed into a *.mexw64 for windows or a *.mexa64 for linux, where the filename is the name of the function callable in Matlab.
This feature enables the separate complex storage representation for complex numbers, which is the only available option for Matlab versions 2017b and prior. Since Matlab internally as well as many mathematical libraries use an interleaved complex representation this can incur unnessecary copying. [Complex Storage Documentation]
This feature enables the interleaved complex storage representation for complex numbers, which is available since Matlab 2018a Update 3. Since many mathematical libraries use an interleaved complex representation this can potentially help avoid copies. This API is slated to become the default for Matlabs mex command as well. [Complex Storage Documentation]
This feature enables automatically linking to the necessary libraries in your Matlab installation. If you need more control over this process you can disable this feature by disabling the default features.