matlab_c

1.1 为什么要用C语言编写MEX文件

MATLAB是矩阵语言，是为向量和矩阵操作设计的，一般来说，如果运算可以用向量或矩阵实现，其运算速度是非常快的。但若运算中涉及到大量的循环处理，MATLAB的速度的令人难以忍受的。解决方法之一为，当必须使用for循环时，把它写为MEX文件，这样不必在每次运行循环中的语句时MATLAB都对它们进行解释。

1.2 编译器的安装与配置

要使用MATLAB编译器，用户计算机上应用事先安装与MATLAB适配的以下任何一种ANSI C/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] None 

Compiler:

(3)选择其中一种(在这里选择了3)，MATLAB让用户进行确认：

Please verify your choices: 

Compiler: Lcc C 2.4 

Location: D:\\MATLAB6P5P1\\sys\\lcc 

Are these correct?([y]/n):

(4)选择y，结束MATLAB编译器的配置。

1.3 一个简单的MEX文件例子

【例1】用m文件建立一个1000×1000的Hilbert矩阵。

tic

m=1000;

n=1000;

a=zeros(m,n);

for i=1:1000

     for j=1:1000

         a(i,j)=1/(i+j);

     end

end

toc

elapsed_time =

     0.1100

    在记事本中输入以下程序：

[Matlab_1.cpp]

#include "mex.h"

//计算过程

void hilb(double *y,int n)

{

        int i,j;

        for(i=0;i               for(j=0;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矩阵的功能。在MATLAB命令窗口输入以下命令：mex Matlab_1.cpp，即可编译成功。进入该文件夹，会发现多了两个文件：Matlab_1.asv和Matlab_1.dll，其中Matlab_1.dll即是MEX文件。运行下面程序：

tic

a=Matlab_1(1000);

toc

elapsed_time =

     0.0470

   由上面看出，同样功能的MEX文件比m文件快得多。

1.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-函数。

1.5 常用的mex-函数和mx-函数

在MATLAB6.5版本中，提供的mx-函数有106个，mex-函数有38个，下面我们仅介绍常用的函数。

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文件时，各输入参数已存在，所以在接口过程中不需要再为这些参数分配内存。

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显示警告信息后继续执行。

3．mexCallMATLAB和mexEvalString

两函数具体格式如下：

#include "mex.h"

int mexCallMATLAB(int nlhs, mxArray *plhs[],

int nrhs, mxArray *prhs[], const char *command_name);

int mexEvalString(const char *command);

mexCallMATLAB前四个参数的含义与mexFunction的参数相同，command_name可以MATLAB内建函数名、用户自定义函数、M文件或MEX文件名构成的字符串，也可以MATLAB合法的运算符。

mexEvalString用来操作MATLAB空间已存在的变量，它不返回任何参数。

mexCallMATLAB与mexEvalString差异较大，请看下面的例子。

【例2】试用MEX文件求5阶完全图邻接矩阵 的特征值及对应的特征向量。

5阶完全图的邻接矩阵为：

下面是求该矩阵的MEX文件。

[Matlab_2.cpp]

#include "mex.h"

void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[])

{

        double x;

        mxArray *y,*z,*w;

        int n;

        if (nrhs!=1)

               mexErrMsgTxt("One inputs required.");

        if (nlhs != 3) 

               mexErrMsgTxt("Three output required.");

        if (!mxIsDouble(prhs[0])||mxGetN(prhs[0])*mxGetM(prhs[0])!=1)

               mexErrMsgTxt("Input must be a scalar.");

        x=mxGetScalar(prhs[0]);

        plhs[0]=mxCreateDoubleMatrix(x,x,mxREAL);

        plhs[1]=mxCreateDoubleMatrix(x,x,mxREAL);

        plhs[2]=mxCreateDoubleMatrix(x,x,mxREAL);

       n=mxGetM(plhs[0]);

        y=plhs[0];

        z=plhs[1];

        w=plhs[2];

        //利用mexCallMATLAB计算特征值

        mexCallMATLAB(1,&plhs[1],1,prhs,"ones");

        mexCallMATLAB(1,&plhs[2],1,prhs,"eye");

        mexCallMATLAB(1,&plhs[0],2,&plhs[1],"-");

        mexCallMATLAB(2,&plhs[1],1,&plhs[0],"eig");

        //演示mexEvalString的功能

        mexEvalString("y=y*2");

        mexEvalString("a=a*2");

}

在MATLAB命令窗口输入以下命令：

>> mex Matlab_2.cpp

>> clear

>> a=magic(5)

a =

     17     24      1      8     15

     23      5      7     14     16

      4      6     13     20     22

     10     12     19     21      3

     11     18     25      2      9

>> [y,z,w]=Matlab_2(5)

? Undefined function or variable 'y'.

a =

     34     48      2     16     30

     46     10     14     28     32

      8     12     26     40     44

     20     24     38     42      6

     22     36     50      4     18

y =

      0      1      1      1      1

      1      0      1      1      1

      1      1      0      1      1

      1      1      1      0      1

      1      1      1      1      0

z =

     0.8333    -0.1667    -0.1667     0.2236     0.4472

    -0.1667     0.8333    -0.1667     0.2236     0.4472

    -0.1667    -0.1667     0.8333     0.2236     0.4472

    -0.5000    -0.5000    -0.5000     0.2236     0.4472

          0          0          0    -0.44     0.4472

w =

     -1      0      0      0      0

      0     -1      0      0      0

      0      0     -1      0      0

      0      0      0     -1      0

      0      0      0      0      4

由上面可以看出，K5的特征值为–1和4，其中–1是四重根。MATLAB提供了mexGetVariable、mexPutVariable函数，以实现MEX空间与其它空间交换数据的任务，具体可以参看MATLAB帮助文档。

4．建立二维双精度矩阵函数mxCreateDoubleMatrix

    其格式具体如下：

#include "matrix.h"

mxArray *mxCreateDoubleMatrix(int m, int n, mxComplexity ComplexFlag);

    其中m代表行数，n代表列数，ComplexFlag可取值mxREAL 或mxCOMPLEX。如果创建的矩阵需要虚部，选择mxCOMPLEX，否则选用mxREAL。

    类似的函数有：

其格式如下：

#include "matrix.h"

int mxGetM(const mxArray *array_ptr);

int mxGetN(const mxArray *array_ptr);

与之相关的还有：

mxSetM：设置矩阵的行维

mxSetN：设置矩阵的列维

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)

{

        int i;

        //实现字符串倒序

        for(i=0;i               *(output_buf+i)=*(input_buf+buflen-i-2);

}

void mexFunction(int nlhs,mxArray *plhs[],int nrhs,const mxArray *prhs[])

{

        //定义输入和输出参量的指针

        char *input_buf,*output_buf;

        int buflen,status;

        //检查输入参数个数

        if(nrhs!=1)

               mexErrMsgTxt("One input required.");

        else if(nlhs>1)

               mexErrMsgTxt("Too many output arguments.");

        //检查输入参数是否是一个字符串

        if(mxIsChar(prhs[0])!=1)

               mexErrMsgTxt("Input must be a string.");

        //检查输入参数是否是一个行变量

        if(mxGetM(prhs[0])!=1)

               mexErrMsgTxt("Input must a row vector.");

        //得到输入字符串的长度

        buflen=(mxGetM(prhs[0])*mxGetN(prhs[0]))+1;

        //为输入和输出字符串分配内存

        input_buf=mxCalloc(buflen,sizeof(char));

        output_buf=mxCalloc(buflen,sizeof(char));

        //将输入参量的mxArray结构中的数值拷贝到C类型字符串指针

        status=mxGetString(prhs[0],input_buf,buflen);

        if(status!=0)

               mexWarnMsgTxt("Not enough space. String is truncated.");

        //调用C程序

        revord(input_buf,buflen,output_buf);

        plhs[0]=mxCreateString(output_buf);

}

这个程序中需要注意的地方是mxCalloc函数，它代替了标准C程序中的calloc函数用于动态分配内存，而mxCalloc函数采用的是MATLAB的内存管理机制，并将所有申请的内存初始化为0，因此凡是C代码需要使用calloc函数的地方，对应的Mex文件应该使用mxCalloc函数。同样，凡是C代码需要使用realloc函数的地方，对应的Mex文件应该使用mxRealloc函数。

在MATLAB命令窗口中对revord.cpp程序代码编译链接：

>> mex revord.cpp

在MATLAB命令窗口中对C-MEX文件revord.dll进行测试：

>> x='I am student.';

>> revord(x)

ans =

.tneduts ma