如果我有一个用C语言写的函数,实现了一个功能,如一个简单的函数: double add(double x, double y) { return x + y; } 要得出以上的结果,那应该怎样做呢?
解决方法之一是要通过使用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 --> "del _lib94902.obj" 也就是说,虽然在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) {
} // MEX文件接口函数 void mexFunction(int nlhs,mxArray *plhs[], int nrhs,const mxArray *prhs[]) {
} 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文件
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? 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] None Compiler: Please verify your choices: Compiler: Lcc C 2.4 Location: D:\MATLAB6P5P1\sys\lcc Are these correct?([y]/n): 3 一个简单的MEX文件例子 【例1】用m文件建立一个1000×1000的Hilbert矩阵。 tic m=1000; n=1000; a=zeros(m,n); for i=1:1000
end toc #include "mex.h" //计算过程 void hilb(double *y,int n) {
} //接口过程 void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[]) {
}
tic a=Matlab_1(1000); toc
4 MEX文件的组成与参数 MEX文件的源代码一般由两部分组成: (1)计算过程。该过程包含了MEX文件实现计算功能的代码,是标准的C语言子程序。
(2)入口过程。该过程提供计算过程与MATLAB之间的接口,以入口函数mxFunction实现。在该过程中,通常所做的工作是检测输入、输出参数个数和类型的正确性,然后利用mx-函数得到MATLAB传递过来的变量(比如矩阵的维数、向量的地址等),传递给计算过程。 MEX文件的计算过程和入口过程也可以合并在一起。但不管那种情况,都要包含#include
"mex.h",以保证入口点和接口过程的正确声明。注意,入口过程的名称必须是mexFunction,并且包含四个参数,即: void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray
*prhs[])
其中,参数nlhs和nrhs表示MATLAB在调用该MEX文件时等式左端和右端变量的个数,例如在MATLAB命令窗口中输入以下命令: [a,b,c]=Matlab_1(d,e,f,g) 则nlhs为3,nrhs为4。
MATLAB在调用MEX文件时,输入和输出参数保存在两个mxArray*类型的指针数组中,分别为prhs[]和plhs[]。prhs[0]表示第一个输入参数,prhs[1]表示第二个输入参数,…,以此类推。如上例中,d→prhs[0],e→prhs[1],f→prhs[2],f→prhs[3]。同时注意,这些参数的类型都是mxArray
*。 接口过程要把参数传递给计算过程,还需要从prhs中读出矩阵的信息,这就要用到下面的mx-函数和mex-函数。 在MATLAB6.5版本中,提供的mx-函数有106个,mex-函数有38个,下面我们仅介绍常用的函数。 5.1入口函数mexFunction 该函数是C MEX文件的入口函数,它的格式是固定的: void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray
*prhs[])
说明:MATLAB函数的调用方式一般为:[a,b,c,…]=被调用函数名称(d,e,f,…),nlhs保存了等号左端输出参数的个数,指针数组plhs具体保存了等号左端各参数的地址,注意在plhs各元素针向的mxArray内存未分配,需在接口过程中分配内存;prhs保存了等号右端输入参数的个数,指针数组prhs具体保存了等号右端各参数的地址,注意MATLAB在调用该MEX文件时,各输入参数已存在,所以在接口过程中不需要再为这些参数分配内存。 5.2出错信息发布函数mexErrMsgTxt,mexWarnMsgTxt 两函数的具体格式如下: #include "mex.h" void mexErrMsgTxt(const char *error_msg); void mexWarnMsgTxt(const char *warning_msg);
其中error_msg包含了要显示错误信息,warning_msg包含要显示的警告信息。两函数的区别在于mexErrMsgTxt显示出错信息后即返回到MATLAB,而mexWarnMsgTxt显示警告信息后继续执行。 5.3 mexCallMATLAB和mexString 两函数具体格式如下: #include "mex.h" int mexCallMATLAB(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[], const char *command_name); int mexString(const char *command); mexCallMATLAB前四个参数的含义与mexFunction的参数相同,command_name可以MATLAB内建函数名、用户自定义函数、M文件或MEX文件名构成的字符串,也可以MATLAB合法的运算符。 mexString用来操作MATLAB空间已存在的变量,它不返回任何参数。 mexCallMATLAB与mexString差异较大,请看下面的例子。 【例2】试用MEX文件求5阶完全图邻接矩阵 的特征值及对应的特征向量。 下面是求该矩阵的MEX文件。 [Matlab_2.cpp] #include "mex.h" void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[]) {
} 在MATLAB命令窗口输入以下命令: >> mex Matlab_2.cpp >> clear >> a=magic(5) a =
>> [y,z,w]=Matlab_2(5) Undefined function or variable 'y'. a =
y =
z =
w =
5.4建立二维双精度矩阵函数mxCreateDoubleMatrix 其格式具体如下: #include "matrix.h" mxArray *mxCreateDoubleMatrix(int m, int n, mxComplexity ComplexFlag); 其中m代表行数,n代表列数,ComplexFlag可取值mxREAL
或mxCOMPLEX。如果创建的矩阵需要虚部,选择mxCOMPLEX,否则选用mxREAL。
5.5 获取行维和列维函数mxGetM、mxGetN 其格式如下: #include "matrix.h" int mxGetM(const mxArray *array_ptr); int mxGetN(const mxArray *array_ptr); 与之相关的还有: mxSetM:设置矩阵的行维 mxSetN:设置矩阵的列维 5.6 获取矩阵实部和虚部函数mxGetPr、mxGetPi 其格式如下: #include "matrix.h" double *mxGetPr(const mxArray *array_ptr); double *mxGetPi(const mxArray *array_ptr); 与之相关的函数还有: mxSetPr:设置矩阵的实部 mxSetPi:设置矩阵的虚部 【例3】实现字符串的倒序输出。 #include "mex.h" void revord(char *input_buf,int buflen,char *output_buf) {
} void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[]) {
}
在MATLAB命令窗口中对revord.cpp程序代码编译链接: >> mex revord.cpp 在MATLAB命令窗口中对C-MEX文件revord.dll进行测试: >> x='I am student.'; >> revord(x) ans = .tneduts ma I 终于写完了,相信大家对mex文件应该有点熟悉了,具体还要到实际应用中慢慢体会。 |
|