用c 编写mex 程序

(re-edited by yangfanboy in Dalian Maritime University)
该文章原作者为：dodoo (虚怀)，文章来源为：bbs 水木清华 。
谢谢原作者给我们奉献的精彩教程。本人经过适当编辑，修改了原贴上的各种叙述和程序
代码的错误，最后将文章中提到的源文件和dll 文献附上，便于大家实践。
大家都知道，matlab 是一种解释型的编程环境，也就是说，跟以前的basic 一样，是
读 一句执行一句的。这样做可以很方便的实现编程过程中的交互，也免去了麻烦又耗时的
编译过程。但凡事有一利必有一弊，matlab 在执行时速度慢也就根源于此。
在matlab 里敲入：
for i=1:10000
b(i)=a(10001-i);
end
怎么样，是不是很慢？ 你的程序里如果再多几个这样的循环，运行速度就可想而知了。
上面程序的功能是将向量a 里的数据逆序赋给向量b。下面的程序可以实现相同的功能 ：
b=a(10000:-1:1);
为什么这个程序运行速度就这么快呢？这是因为matlab 里的基础矩阵运算函数，像转
置，复制等等，都是以二进制程序的形式存在的，运行起来速度当然比解释执行10000 次
要快很多。所以编matlab 程序时，应该尽量避免用循环语句，而使用等效的矩阵运算。虽
然这样，但总是有的时候没法找到对应的矩阵运算来等效，或编出来的程序复杂得让人没
法修简单地说，mex 程序就是根据一定的接口规范（mtlab 提出的）编写的一个dll，matla
比如我编了一个mex 函数，名字叫max2.dll，那么只要把这个dll 所在的目录加到matlab
的搜索路径里（用addpath），就可以像调用普通matlab 函数一样来调用它了。因为把循
环体放到了二进制程序中，执行速度快得多。
Mex 文件既可以用c，也可以用fortran 来编。因为我用的是c 语言，所以下面的介绍
都是用c 语言编写mex 文件的方法。如果你用的是fortran，请你自己去看Apiguide.pdf，
里面有详细说明。
前面说到通过把耗时长的函数用c 语言实现，并编译成mex 函数可以加快执行速度。
Matlab7.0 本身是带有c 语言的编译器的，所以要求你的机器上已经安装有VC,BC 或Wat
com C 中的一种，也可以选择使用他们的编译器。如果你在安装Matlab 时已经设置过编译
器，那么现在你应该就可以使用mex 命令来编译c 语言的程序了。如果当时没有选，只要
在Matlab 里键入
mex -setup ，就会出现一个DOS 方式窗口，下面只要根据提示一步步设置就可以了。
以下是我装了VC6.0 后键入命令mex -setup 出现的界面：
Please choose your compiler for building external interface (MEX) files:
Would you like mex to locate installed compilers [y]/n?
敲入y 后，出现以下界面
Select a compiler:
[1] Digital Visual Fortran version 6.0 in C:\Program Files\Microsoft Visual Studio
[2] Lcc C version 2.4 in D:\MATLAB704\sys\lcc
[3] Microsoft Visual C/C++ version 6.0 in C:\Program Files\Microsoft Visual Studio
使用C 语言，可以选择2 或者3，但lcc 有一个问题是不支持中文注释，所以建议选择
3，如果没有装VC，只有lcc 的朋友，
在写c 语言程序时一定不要使用中文注释，否则会出现错误。
接下来要注意路径问题，c 语言程序必须放在当前目录下才能编译，放在搜索目录下面
是无效的。为了测试你的路径设置正确与否，把下面的程序
存为hello.c。
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
mexPrintf("hello,world!\n");
}
现在敲： mex hello.c
如果一切顺利，编译应该在出现编译器提示信息后正常退出。看看当前目录下，你会发
现多了一个文件：hello.dll。
现在键入
hello
程序会在屏幕上打出一行： hello,world!
这样，第一个mex 函数就算完成了。怎么样，很简单吧。下面对这个最简单的程序进行
分析，并给它增加一些功能。 分析hello.c，可以看到程序的结构是十分简单的，整个程
序由一个接口子过程mexFunction 构成。前面提到过，Matlab 的mex 函数有一定的接口规
范，就是指
nlhs：输出参数数目
plhs：指向输出参数的指针
nrhs：输入参数数目
prhs：指向输入参数的指针
例如，使用 [a,b]=test(c,d,e) 调用mex 函数test 时，传给test 的这四个参数分别是2
个plhs，3 个prhs。其中： prhs[0]=c prhs[1]=d prhs[2]=e
当函数返回时，将会把你放在plhs[0]，plhs[1]地址的数值赋给a 和b，达到返回数据的
目的。
细心的你也许已经注意到，prhs[i]和plhs[i]都是指向类型mxArray 类型数据的指针。
这个类型是在mex.h 中定义的，事实上，在Matlab 里大多数数据都是以这种类型存在。
当然还有其他的数据类型，可以参考Apiguide.pdf 里的介绍。
为了让大家能更直观地了解参数传递的过程，我们把hello.c 改写一下，使它能根据输
入参数的变化给出不同的屏幕输出：
//hello.c 2.0
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
int i;
i=mxGetScalar(prhs[0]);
if(i==1)
mexPrintf("hello,world!\n");
else
mexPrintf("大家好！\n");
}
将这个程序编译通过后，执行
hello(1)
屏幕上会打出： hello,world!
hello(0)
将会得到：大家好！
现在，程序hello 已经可以根据输入参数来给出相应的屏幕输出。在这个程序里，除了用
到了屏幕输出函数mexPrintf（用法跟c 里的printf 函数几乎完全一样）外，还用到了一
个函数：mxGetScalar，调用方式如下：
i=mxGetScalar(prhs[0]);
"Scalar"就是标量的意思。在Matlab 里数据都是以数组的形式存在的，mxGetScalar 的
作用就是把通过prhs[0]传递进来的mxArray 类型的指针指向的数据（标量）赋给C 程序里
的变量。这个变量本来应该是double 类型的，通过强制类型转换赋给了整形变量i。 既
然有标量，显然还应该有矢量，否则矩阵就没法传了。看下面的程序：
//hello.c 2.1
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
int *i;
i=mxGetPr(plhs[0]);
if(i[0]==1)
mexPrintf("hello,world!\n");
else
mexPrintf("大家好！\n");
}
编者注：这个程序我的理解是如果在matlab 里面键入
a＝1:5；
hello2_1（a）
最后的输出应该是
hello,world!
因为i 通过mxGetPr 得到矩阵a 的指针，a[0]对应的值为1，所以应该显示hello,world!。实际上上述程
序不管我输入什么都显示大家好，我没有想明白，知道的发信给我：xuxkboy@newmail.dlmu.edu.cn
这样，就通过mxGetPr 函数从指向mxArray 类型数据的prhs[0]获得了指向double 类型的
指针。 但是，还有个问题，如果输入的不是单个的数据，而是向量或矩阵，那该怎么处理
呢？通过mxGetPr 只能得到指向这个矩阵的指针，如果我们不知道这个矩阵的确切大小，
就没法对它进行计算。
为了解决这个问题，Matlab 提供了两个函数mxGetM 和mxGetN 来获得传进来参数的行数
和列数。下面例程的功能很简单，就是获得输入的矩阵，把它在屏幕上显示出来：
//show.c 1.0
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
double *data;
int M,N;
int i,j;
data=mxGetPr(prhs[0]); //获得指向矩阵的指针
M=mxGetM(prhs[0]); //获得矩阵的行数
N=mxGetN(prhs[0]); //获得矩阵的列数
for(i=0;i<M;i++)
{
for(j=0;j<N;j++)
mexPrintf("%4.3f ",data[j*M+i]);
mexPrintf("\n");
}
}
编译完成后，用下面的命令测试一下：
a=1:10;
b=[a;a+1];
show(a)
show(b)
将会出现如下显示：
1.000 2.000 3.000 4.000 5.000 6.000 7.000 8.000 9.000 10.000
1.000 2.000 3.000 4.000 5.000 6.000 7.000 8.000 9.000 10.000
2.000 3.000 4.000 5.000 6.000 7.000 8.000 9.000 10.000 11.000
需要注意的是，在Matlab 里，矩阵第一行是从1 开始的，而在C 语言中，第一行的序数
为零，Matlab 里的矩阵元素b(i,j)在传递到C 中的一维数组data 后对应于data[j*M+i]。
输入数据是在函数调用之前已经在Matlab 里申请了内存的，由于mex 函数与Matlab 共用
同一个地址空间，因而在prhs[]里传递指针就可以达到参数传递的目的。但是，输出参数
却需要在mex 函数内申请到内存空间，才能将指针放在plhs[]中传递出去。由于返回指针
类型必须是mxArray，所以Matlab 专门提供了一个函数：mxCreateDoubleMatrix 来实现内
存的申请，函数原型如下：
mxArray *mxCreateDoubleMatrix(int m, int n, mxComplexity ComplexFlag)
m：待申请矩阵的行数
n：待申请矩阵的列数
为矩阵申请内存后，得到的是mxArray 类型的指针，就可以放在plhs[]里传递回去了。但
是对这个新矩阵的处理，却要在函数内完成，这时就需要用到前面介绍的mxGetPr。使用
mxGetPr 获得指向这个矩阵中数据区的指针（double 类型）后，就可以对这个矩阵进行各
种操作和运算了。下面的程序是在上面的show.c 的基础上稍作改变得到的，功能是将输入
的数据经过一定变化后输出。
//reverse.c 1.0
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
double *inData;
double *outData;
int M,N;
int i,j;
inData=mxGetPr(prhs[0]);
M=mxGetM(prhs[0]);
N=mxGetN(prhs[0]);
plhs[0]=mxCreateDoubleMatrix(M,N,mxREAL);
outData=mxGetPr(plhs[0]);
for(i=0;i<M;i++)
for(j=0;j<N;j++)
outData[j*M+i]=inData[(N-1-j)*M+i];
}
敲入：a=[1,2,3;2,3,4;3,4,5;4,5,6]
这时屏幕显示：
a =
1 2 3
2 3 4
3 4 5
4 5 6
敲入：b=reverse_1(a)
显示：b =
3 2 1
4 3 2
5 4 3
6 5 4
当然，Matlab 里使用到的并不是只有double 类型这一种矩阵，还有字符串类型、稀疏矩
阵、结构类型矩阵等等，并提供了相应的处理函数。本文用到编制mex 程序中最经常遇到
的一些函数，其余的详细情况清参考Apiref.pdf。
通过前面两部分的介绍，大家对参数的输入和输出方法应该有了基本的了解。具备了这
些知识，就能够满足一般的编程需要了。但这些程序还有些小的缺陷，由于前面的例程中
没有对输入、输出参数的数目及类型进行检查，导致程序的容错性很差。
//reverse.c 2.0
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[],int nrhs, const mxArray *prhs[])
{
double *inData;
double *outData;
int M,N; int i,j;
//异常处理
if(nrhs!=1)
mexErrMsgTxt("USAGE: b=reverse(a)\n");
if(!mxIsDouble(prhs[0]))
mexErrMsgTxt("the Input Matrix must be double!\n");
inData=mxGetPr(prhs[0]);
M=mxGetM(prhs[0]);
N=mxGetN(prhs[0]);
plhs[0]=mxCreateDoubleMatrix(M,N,mxREAL);
outData=mxGetPr(plhs[0]);
for(i=0;i<M;i++)
for(j=0;j<N;j++)
outData[j*M+i]=inData[(N-1-j)*M+i];
}
敲入：b=reverse_2(a)
显示：b =
3 2 1
4 3 2
5 4 3
6 5 4
敲入：b=reverse_2(a,a)
显示：??? USAGE: b=reverse(a)
敲入：char ‘I like matlab’
显示：ans =I like matlab
敲入：a1=ans; b=reverse_2(a1)
显示：??? the Input Matrix must be double!
在上面的异常处理中，使用了两个新的函数：mexErrMsgTxt 和mxIsDouble。MexErrMsgTxt
在给出出错提示的同时退出当前程序的运行。MxIsDouble 则用于判断mxArray 中的数据
是否double 类型。当然Matlab 还提供了许多用于判断其他数据类型的函数，这里不加详
述。 需要说明的是，Matlab 提供的API 中，函数前缀有mex-和mx-两种。带mx-前缀的大
多是对mxArray 数据进行操作的函数，如mxIsDouble,mxCreateDoubleMatrix 等等。而带
mx 前缀的则大多是与Matlab 环境进行交互的函数，如mexPrintf，mxErrMsgTxt 等等。了
解了这一点，对在Apiref.pdf 中查找所需的函数很有帮助。
至此为止，使用C 编写mex 函数的基本过程已经介绍完了。
下面介绍一个非常有用的函数调用。
我们之所以使用Matlab，很重要的考虑是Matlab 提供了相当丰富的矩阵运算函数和各
种toolbox。在编制mex 函数时，有时我们也会遇到一些操作，为了在mex 函数里调用Matlab
命令，我们就需要用到一个函数mexCallMATLAB，原型如下：
int mexCallMATLAB(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[],const char
*command_name);
有了前面的基础，使用这个函数就显得十分容易了。
下面给出一个例程，功能是将输入矩阵转置后然后输出
rot.c
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
double *inData;
mxArray *IN[1];
mxArray *OUT[1];
double *outData;
int M,N;
int i,j;
//异常处理
if(nrhs!=1)
mexErrMsgTxt("USAGE: b=rot(a)\n");
if(!mxIsDouble(prhs[0]))
mexErrMsgTxt("the Input Matrix must be double!\n");
//计算转置
if(mexCallMATLAB(1,OUT,1,prhs,"'"))
mexErrMsgTxt("Error when compute!\n");
//根据输入参数数目决定是否显示
if(nlhs==0)
mexCallMATLAB(0,IN,1,OUT,"disp");
else
plhs[0]=OUT[0];
}
敲入：a=[1,2,3;2,3,4;3,4,5;4,5,6]
这时屏幕显示：
a =
1 2 3
2 3 4
3 4 5
4 5 6
敲入：c=rot(a)
显示：c =
1 2 3 4
2 3 4 5
3 4 5 6
关于这个例子，相信大家一看就明白，我就不多说了。
通过这两天的学习，发现使用C 语言编制Mex 算法程序，对于提高算法的性能有很大帮助。
希望该文档能帮助大家进入matlab 和c 语言之间互动的世界，也期待你编制更多的原创程
序奉献给研学论坛，尤其是混沌和分形版面。