Matlab以MEX方式“调用”C源代码

Matlab以MEX方式“调用”C源代码阅读() 评论() 发表时间：2008年09月26日 00:46本文地址：/blog/3311493-1222361217如果我有一个用C语言写的函数，实现了一个功能，如一个简单的函数：double add(double x, double y){return x + y;}现在我想要在Matlab中使用它，比如输入：>> a = add(1.1, 2.2)3.3000要得出以上的结果，那应该怎样做呢？解决方法之一是要通过使用MEX文件，MEX文件使得调用C函数和调用Matlab的内置函数一样方便。

MEX文件是由原C代码加上MEX文件专用的接口函数后编译而成的。

可以这样理解，MEX文件实现了一种接口，它把在Matlab中调用函数时输入的自变量通过特定的接口调入了C函数，得出的结果再通过该接口调回Matlab。

该特定接口的操作，包含在mexFunction这个函数中，由使用者具体设定。

所以现在我们要写一个包含add和mexFunction的C文件，Matlab调用函数，把函数中的自变量（如上例中的1.1和2.2）传给 mexFunction的一个参数，mexFunction把该值传给add，把得出的结果传回给mexFunction的另一个参数，Matlab通过该参数来给出在Matlab 语句中调用函数时的输出值（如上例中的a）。

值得注意的是，mex文件是与平台有关的，以我的理解，mex文件就是另类的动态链接库。

在matlab6.5中使用mex -v 选项，你可以看到最后mex阶段有类似如下的信息：--> "del _lib94902.obj"--> "del "test.exp""--> "del "test.lib""也就是说，虽然在matlab6.5生成的是dll文件，但是中间确实有过lib文件生成。

比如该C文件已写好，名为add.c。

那么在Matlab中，输入：>> mex add.c就能把add.c编译为MEX文件（编译器的设置使用指令mex-setup），在Windows中，MEX 文件类型为mexw32，即现在我们得出add.mexw32文件。

现在，我们就可以像调用M函数那样调用MEX文件，如上面说到的例子。

所以，通过MEX文件，使用C函数就和使用M函数是一样的了。

我们现在来说mexFunction怎样写。

mexFunction的定义为：void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[]) {/*....................................*/}可以看到，mexFunction是没返回值的，它不是通过返回值把结果传回Matlab的，而是通过对参数plhs的赋值。

mexFunction的四个参数皆是说明Matlab调用MEX文件时的具体信息，如这样调用函数时：>> b = 1.1; c = 2.2;>> a = add(b, c)mexFunction四个参数的意思为：nlhs = 1，说明调用语句左手面（lhs－left hand side）有一个变量，即a。

nrhs = 2，说明调用语句右手面（rhs－right hand side）有两个自变量，即b和c。

plhs是一个数组，其内容为指针，该指针指向数据类型mxArray。

因为现在左手面只有一个变量，即该数组只有一个指针，plhs[0]指向的结果会赋值给a。

prhs和plhs类似，因为右手面有两个自变量，即该数组有两个指针，prhs[0]指向了b，prhs[1]指向了c。

要注意prhs是const的指针数组，即不能改变其指向内容。

因为Matlab最基本的单元为array，无论是什么类型也好，如有double array、 cell array、struct array……所以a,b,c都是array，b = 1.1便是一个1x1的double array。

而在C 语言中，Matlab的array使用mxArray类型来表示。

所以就不难明白为什么plhs和prhs 都是指向mxArray类型的指针数组。

完整的add.c如下：#include "mex.h" // 使用MEX文件必须包含的头文件// 执行具体工作的C函数double add(double x, double y){return x + y;}// MEX文件接口函数void mexFunction(int nlhs,mxArray *plhs[], int nrhs,const mxArray *prhs[]){double *a;double b, c;plhs[0] = mxCreateDoubleMatrix(1, 1, mxREAL);a = mxGetPr(plhs[0]);b = *(mxGetPr(prhs[0]));c = *(mxGetPr(prhs[1]));*a = add(b, c);}mexFunction的内容是什么意思呢？我们知道，如果这样调用函数时：>> output = add(1.1, 2.2);在未涉及具体的计算时，output的值是未知的，是未赋值的。

所以在具体的程序中，我们建立一个1x1的实double矩阵（使用 mxCreateDoubleMatrix函数，其返回指向刚建立的mxArray的指针），然后令plhs[0]指向它。

接着令指针a指向plhs [0]所指向的mxArray 的第一个元素（使用mxGetPr函数，返回指向mxArray的首元素的指针）。

同样地，我们把prhs[0]和prhs [1]所指向的元素（即1.1和2.2）取出来赋给b和c。

于是我们可以把b 和c作自变量传给函数add，得出给果赋给指针a所指向的mxArray中的元素。

因为a是指向plhs[0]所指向的mxArray的元素，所以最后作输出时，plhs[0]所指向的mxArray赋值给output，则 output便是已计算好的结果了。

上面说的一大堆指向这指向那，什么mxArray，初学者肯定都会被弄到头晕眼花了。

很抱歉，要搞清楚这些乱糟糟的关系，只有多看多练。

实际上mexFunction是没有这么简单的，我们要对用户的输入自变量的个数和类型进行测试，以确保输入正确。

如在add函数的例子中，用户输入char array便是一种错误了。

从上面的讲述中我们总结出，MEX文件实现了一种接口，把C语言中的计算结果适当地返回给Matlab罢了。

当我们已经有用C编写的大型程序时，大可不必在 Matlab里重写，只写个接口，做成MEX文件就成了。

另外，在Matlab程序中的部份计算瓶颈（如循环），可通过MEX文件用C语言实现，以提高计算速度。

以上是对mex文件的初步认识，下面详细介绍如何用c语言编写mex文件：1 为什么要用C语言编写MEX文件 MATLAB是矩阵语言，是为向量和矩阵操作设计的，一般来说，如果运算可以用向量或矩阵实现，其运算速度是非常快的。

但若运算中涉及到大量的循环处理，MATLAB的速度的令人难以忍受的。

解决方法之一为，当必须使用for循环时，把它写为MEX文件，这样不必在每次运行循环中的语句时MATLAB都对它们进行解释。

2 编译器的安装与配置要使用MATLAB编译器，用户计算机上应用事先安装与MATLAB适配的以下任何一种ANSIC/C++编译器：5.0、6.0版的MicroSoft Visual C++(MSVC)5.0、5.2、5.3、5.4、5.5版的Borland C++LCC(由MATLAB自带，只能用来产生MEX文件)下面是安装与配置MATLAB编译器应用程序MEX的设置的步骤：(1)在MATLAB命令窗口中运行mex–setup，出现下列提示：Please choose your compiler for building external interface (MEX) files:Would you like mex to locate installed compilers [y]/n?(2)选择y，MATLAB将自动搜索计算机上已安装的外部编译器的类型、版本及所在路径，并列出来让用户选择：Select a compiler:[1] Borland C++Builder version 6.0 in C:\Program Files\Borland[2] Digital Visual Fortran version 6.0 in C:\Program Files\Microsoft Visual Studio[3] Lcc C version 2.4 in D:\MATLAB6P5P1\sys\lcc[4] Microsoft Visual C/C++ version 6.0 in C:\Program Files\Microsoft Visual Studio [0] NoneCompiler:(3)选择其中一种(在这里选择了3)，MATLAB让用户进行确认：Please verify your choices:Compiler: Lcc C 2.4Location: D:\MATLAB6P5P1\sys\lccAre these correct?([y]/n):(4)选择y，结束MATLAB编译器的配置。

3 一个简单的MEX文件例子【例1】用m文件建立一个1000×1000的Hilbert矩阵。

ticm=1000;n=1000;a=zeros(m,n);for i=1:1000for j=1:1000a(i,j)=1/(i+j);endendtoc在matlab中新建一个Matlab_1.cpp 文件并输入以下程序：#include "mex.h"//计算过程void hilb(double *y,int n){int i,j;for(i=0;i<n;i++)for(j=0;j<n;j++)*(y+j+i*n)=1/((double)i+(double)j+1);}//接口过程void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[]) {double x,*y;int n;if (nrhs!=1)mexErrMsgTxt("One inputs required.");if (nlhs != 1)mexErrMsgTxt("One output required.");if (!mxIsDouble(prhs[0])||mxGetN(prhs[0])*mxGetM(prhs[0])!=1)mexErrMsgTxt("Input must be scalars.");x=mxGetScalar(prhs[0]);plhs[0]=mxCreateDoubleMatrix(x,x,mxREAL);n=mxGetM(plhs[0]);y=mxGetPr(plhs[0]);hilb(y,n);}该程序是一个C语言程序，它也实现了建立Hilbert矩阵的功能。