MATLAB引擎方式实现VC与MATLAB混合编程

转自（加以修改完善）：http://www.caesv.cn/html/kexuejisuan/MatLabjiaocheng/2009/1105/5943.html

VS2008是当前主流的应用程序开发环境之一，开发环境强大，开发的程序执行速度快。但在科学计算方面函数库显得不够丰富、读取、显示数据图形不方便。Matlab是一款将数值分析、矩阵计算、信号处理和图形显示结合在一起，包含大量高度集成的函数可供调用，适合科学研究、工程设计等众多学科领域使用的一种简洁、高效的编程工具。不过由于Matlab使用的是解释性语言，大大限制了它的执行速度和应用场合。基于VC和Matlab混合编程是很多熟悉VC++编程而又需要进行科学计算、数据仿真的科研人员常用的一种方式，其中最简单也最直接的方法就是调用Matlab引擎。本文以下部分将详细介绍通过VS2008调用Matlab2007a引擎来达到VC与Matlab数据共享编程的方法。

1. 什么是Matlab引擎

所谓Matlab引擎（engine），是指一组Matlab提供的接口函数，支持C/C++、Fortran等语言，通过这些接口函数，用户可以在其它编程环境中实现对Matlab的控制。可以主要功能有：

打开/关闭一个Matlab对话；

向Matlab环境发送命令字符串；

从Matlab环境中读取数据；

向Matlab环境中写入数据。

与其它各种接口相比，引擎所提供的Matlab功能支持是最全面的。通过引擎方式，应用程序会打开一个新的Matlab进程，可以控制它完成任何计算和绘图操作。对所有的数据结构提供100%的支持。同时，引擎方式打开的Matlab进程会在任务栏显示自己的图标，打开该窗口，可以观察主程序通过engine方式控制Matlab运行的流程，并可在其中输入任何Matlab命令。

实际上，通过引擎方式建立的对话，是将Matlab以ActiveX控件方式启动的。在Matlab初次安装时，会自动执行一次：matlab /regserver，将自己在系统的控件库中注册。如果因为特殊原因，无法打开Matlab引擎，可以在Dos命令提示符后执行上述命令，重新注册。

2. 配置编译器

要在VC中成功编译Matlab引擎程序，必须包含引擎头文件engine.h并引入Matlab对应的库文件libmx.lib、libmat.lib、libeng.lib。具体的说，打开一个工程后，做如下设置：

1) 通过菜单工具/选项，打开选项页，点击项目和解决方案，然后在页面右面“显示以下内容的目录”下拉列表框中选择“包含文件”，添加路径："D:\Program files\MATLAB\R2010a\extern\include"。





2) 选择“库文件”，添加路径：d:\Program Files\MATLAB\R2010a\extern\lib\win32\microsoft。





3) 右击工程/属性，打开项目属性页，选择链接器/输入，在附加依赖项编辑框中，添加文件名libmx.lib libmat.lib libeng.lib。





以上步骤1)、2)只需设置一次，而步骤3)对每个项目都要单独设定。如果安装的Matlab版本很新，以上设置后可能会报错找不到dll，对此可参考另一篇博文http://blog.sina.com.cn/s/blog_6163bdeb0100qd49.html

3. 引擎API详解

在调用Matlab引擎之前，首先应在相关文件中加入一行：#include "enging.h"，该文件包含了引擎API函数的说明和所需数据结构的定义，如下





可以在VC中调用的引擎函数分别如下：

3.1 引擎的打开和关闭

engOpen－打开Matlab engine

函数声明：Engine *engOpen(const char *startcmd);

参数startcmd是用来启动Matlab引擎的字符串参数，在Windows操作系统中只能为NULL。

函数返回值是一个Engine类型的指针，它是在engine.h中定义的engine数据结构。

EngClose－关闭Matlab 引擎

函数声明：int engClose(Engine *ep);

参数ep代表要被关闭的引擎指针。

函数返回值为0表示关闭成功，返回1表示发生错误。

例如，通常用来打开/关闭Matlab引擎的代码如下：

Engine *ep; //定义Matlab引擎指针。

if (!(ep=engOpen(NULL))) //测试是否启动Matlab引擎成功。

{

MessageBox("Can't start Matlab engine!" );

exit(1);

}

. …………

engClose(ep); //关闭Matlab引擎。

3.2 向Matlab发送命令字符串

engString－发送命令让Matlab执行。

函数声明：int engString(Engine *ep, Const char *string);

参数ep为函数engOpen返回的引擎指针，字符串string为要matlab执行的命令。

函数返回值为0表示成功执行，返回1说明执行失败（如命令不能被Matlab正确解释或Matlab引擎已经关闭了）。

3.3 获取Matlab命令窗口的输出

要在VC中获得函数engString发送的命令字符串被Matlab执行后在matlab窗口中的输出，可以调用engOUtputBuffer函数。

函数声明：int engOutputBuffer(Engine *ep, char *p, int n);

参数ep为Matlab引擎指针，p为用来保存输出结构的缓冲区，n为最大保存的字符个数，通常就是缓冲区p的大小。该函数执行后，接下来的engString函数所引起的命令行输出结果会在缓冲区p中保存。如果要停止保存，只需调用代码：engOutputBuffer(ep, NULL, 0)。

3.4 读写Matlab数据

3.4.1从Matlab引擎工作空间中获取变量。

mxArray *engGetVariable(Engine *ep, const char *name);

参数ep为打开的Matlab引擎指针，name为以字符串形式指定的数组名。

函数返回值是指向name数组的指针，类型为mxArray*（mxArray数据类型在本文第4节详细简介）。

3.4.2 向Matlab引擎工作空间写入变量。

int engPutVariable(Engine *ep, const char *name, const mxArray *mp);

参数ep为打开的Matlab引擎指针，mp为指向被写入变量的指针，name为变量写入后在Matlab引擎工作空间中的变量名。

函数返回值为0表示写入变量成功，返回值为1表示发生错误。

3.5 调用引擎时显示/隐藏Matlab主窗口

默认情况下，以engine方式调用Matlab的时候，会打开Matlab主窗口，可在其中随意操作。但有时也会干扰应用程序的运行，可用以下设置是否显示该窗口。

int engSetVisible(Engine *ep, bool value);

参数ep为打开的Matlab引擎指针，value为是否显示的标志，取值true（或1）表示显示Matlab窗口，取值false（或0）表示隐藏Matlab窗口。

函数返回值为0表示设置成功，为1表示有错误发生。

要获得当前Matlab窗口的显示/隐藏情况，可以调用函数：

int engGetVisible(Engine *ep, bool *value);

参数ep为打开的Matlab引擎指针，Value为用来保存显示/隐藏情况的变量（采用指针方式传递）。

函数返回值为0表示获取成功，为1表示有错误发生。

4. 数据类型mxArray的操作

在上节的Matlab引擎函数中，所有与变量有关的数据类型都是mxArray类型。数据结构mxArray以及大量的mx开头的函数，广泛用于Matlab 引擎程序和Matlab C数学库中。mxArray是一种很复杂的数据结构，与Matlab中的array相对应，我们只需熟悉Matlab的array类型和几个常用的mxArray函数即可。

在VC中，所有和Matlab的数据交互都是通过mxArray来实现的，在使用mxArray类型的程序中，应包含头文件matrix.h，不过在引擎程序中，一般会包含头文件engine.h，该文件里面已经包含了matrix.h，因此无需重复包含。

4.1 创建和清除mxArray型数据

Matlab有很多种变量类型，对应于每种类型，基本上都有一个函数用于创建，但它们都有相同的数据结构，就是mxArray。

数组的建立采用mxCreatexxx形式的函数，例如新建一个double类型数组，可用函数mxCreateDoubleMatrix，函数形式如下：

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

参数m和n为矩阵的行数和列数。ComplexFlag为常数，用来区分矩阵中元素是实数还是复数，取值分别为mxREAL和mxCOMPLEX。

例如，创建一个3行5列的二维实数数组，可用如下语句：

mxArray *T = mxCreateDoubleMatrix(3, 5, mxREAL);

对应的，要删除一个数组mxDestroyArray，该函数声明如下：

void mxDestroyArray(mxArray *array_ptr);

参数array_ptr为要删除的数组指针。

例如，要删除上面创建的数组T，可用如下语句：

mxDestroyArray(T);

类似的创建函数还有：

mxArray *mxCreateString(const char *str);

创建一个字符串类型并初始化为str字符串。

一般的在VC与Matlab交互中，以上两种类型就够了，其它类型数组的创建这里不再介绍。

4.2 管理mxArray数据类型

4.2.1 管理mxArray数据大小

要获得mxArray数组每一维上元素的个数，可以用mxGetM和mxGetN函数。其中mxGetM用来获得数组第一维的元素个数，对于矩阵来说就是行数。

int mxGetM(const mxArray *array_ptr); //返回array_ptr对应数组第一维的元素个数（行数）

int mxGetN(const mxArray *array_ptr); //返回array_ptr对应数组其它维的元素个数，对于矩阵来说是列数。对于多维数组来说是从第2维到最后一维的各维元素个数的乘积。

要获得某一特定维的元素个数，则要用函数：

const int *mxGetDimensions(const mxArray *array_ptr);

该函数返回array_ptr各维的元素个数保存在一个int数组中返回。对于常用的矩阵来说，用mxGetM和mxGetN两个函数就可以了。

另外还可以通过mxGetNumberOfDimensions来获得数组的总的维数，用mxSetM、mxSetN设置矩阵的行数和列数，函数说明如下：

mxGetNumberOfDimensions(const mxArray *array_ptr); //返回数组的维数

void mxSetM(mxArray *array_ptr, int m); //设置数组为m行

void mxSetN(mxArray *array_ptr, int n); //设置数组为n列

4.2.2 判断mxArray数组类型

在对mxArray类型的变量进行操作之前，可以验证以下其中的数组的数据类型，比如是否为double数组、整数、字符串、逻辑值等，以及是否为某种结构、类、或者是特殊类型，比如是否为空数组，是否为inf、NaN等。常见的判断函数有：

bool mxIsDouble(const mxArray *array_ptr);

bool mxIsComplex(const mxArray *array_ptr);

bool mxIsChar(const mxArray *array_ptr);

bool mxIsEmpty(const mxArray *array_ptr);

bool mxIsInf(double value);

…… ……

这些函数比较简单，意义自明，不再解释。

4.2.3 管理mxArray数组的数据

对于常用的double类型的数组，可以用mxGetPr和mxGetPi两个函数分别获得其实部和虚部的数据指针，这两个函数的声明如下：

double *mxGetPr(const mxArray *array_ptr); //返回数组array_ptr的实部指针

double *mxGetPi(const mxArray *array_ptr); //返回数组array_ptr的虚部指针

这样，就可以通过获得的指针对mxArray类型的数组中的数据进行读写操作。例如可以用函数engGetVariable从Matlab工作空间读入mxArray类型的数组，然后用mxGetPr和mxGetPi获得数据指针，对并其中的数据进行处理，最后调用engPutVariable函数将修改后的数组重新写入到Matlab工作空间。具体实现见第5节程序实例。

5. 程序实例

对大部分软件研发人员来说利用VC编程方便、高效，但是要显示数据图形就不那么容易了，这时候不防借助Matlab引擎辅助画图做数据分析。下面通过实例演示如何利用VC调用Matlab绘图，程序的主要功能是在VC中对数组x计算函数值y＝sin(x) ±log(x)，然后调用Matlab绘制y对x的图形。

在VC中新建工程，编写代码如下：

eg1.

#include <cstdio>

#include <iostream>

#include <math.h>

#include "engine.h"

using namespace std;

void main()

{

const int N = 50;

double x
,y
;

int j = 1;

for (int i=0; i<N; i++) // 计算数组x和y

{

x[i] = (i+1);

y[i] = sin(x[i]) + j * log(x[i]);

j *= -1;

}

// 启动Matlab引擎

Engine *ep; // 定义Matlab引擎指针

if (!(ep=engOpen(NULL))) // 是否成功启动Matlab引擎

{

cout<<"Can't start Matlab engine!"<<endl;

exit(1);

}

// 定义mxArray，为1行N列的实数数组。

mxArray *xx = mxCreateDoubleMatrix(1,N, mxREAL);

mxArray *yy = mxCreateDoubleMatrix(1,N, mxREAL);

// 数据复制

memcpy(mxGetPr(xx), x, N*sizeof(double)); // 将数组x复制到mxarray数组xx中

memcpy(mxGetPr(yy), y, N*sizeof(double)); // 将数组x复制到mxarray数组yy中

// 写入Matlab空间

engPutVariable(ep, "xx",xx); // 将mxArray数组xx写入到Matlab工作空间，命名为xx

engPutVariable(ep, "yy",yy); // 将mxArray数组yy写入到Matlab工作空间，命名为yy

//向Matlab引擎发送画图命令

engEvalString(ep, "plot(xx, yy); ");

//销毁mxArray数组xx和yy

mxDestroyArray(xx);

mxDestroyArray(yy);

cout<<"Press any key to exit!"<<endl;

cin.get();

// 关闭Matlab引擎

engClose(ep);

}

运行结果如下，黑框为控制台框，下面为启动的Matlab引擎框，右边为画的figure框。





另外一个例子，求矩阵的逆：

#include <iostream>

#include <iomanip>

using namespace std;

#include <engine.h> // 使用VC++和Matlab引擎混合编程就必须加这个头文件,它里面包含了<matrix.h>

#include <string.h>

#pragma comment(lib, "libmat.lib")

#pragma comment(lib, "libmx.lib")

#pragma comment(lib, "libeng.lib")

void main()

{

// 定义循环变量

int i = 0, j = 0;

// 状态变量

int nStatus = 0;

// 定义MATLAB引擎指针

Engine *ep;

// 定义mxArray变量指针

mxArray *A, *B;

// 定义矩阵数组, 注意：VC中矩阵的行列次序与MATLAB正好相反，需要转置

double arData[3][3] = {{7.5,16.3,9.6},{13.2,8.9,12.3},{9.6,5.4,13.7}};

double arResData[3][3];

// 输出原矩阵

cout<<"原矩阵为："<<endl;

for(i = 0; i < 3; i++)

{

for(j = 0; j < 3; j++)

{

cout<<setw(10)<<arData[i][j]<<" ";

}

cout<<endl;

}

// 打开MATLAB引擎

ep = engOpen(NULL); // 在Windows系统中该函数的参数都为“NULL”。

if(ep == NULL)

{

cout<<"无法打开MATLAB引擎。"<<endl;

exit(EXIT_FAILURE);

}

// 是否显示MATLAB窗口：true-显示；false-隐藏。

nStatus = engSetVisible(ep, true); // 设为ture运行时也只是一闪而过

//nStatus = engSetVisible(ep, true);

if(nStatus != 0)

{

cout<<"设置MATLAB显示属性失败。"<<endl;

exit(EXIT_FAILURE);

}

// 为mxArray变量分配空间

A = mxCreateDoubleMatrix(3,3,mxREAL);

B = mxCreateDoubleMatrix(3,3,mxREAL);

if(A == NULL || B == NULL)

{

cout<<"为mxArray变量分配空间失败。"<<endl;

exit(EXIT_FAILURE);

}

// 将数组中的数据写入到mxArray空间中

memcpy((void*)mxGetPr(A),(void*)arData,sizeof(arData)); // 使用内存数据复制函数memcpy进行复制

// 将矩阵变量A写入到MATLAB引擎空间

nStatus = engPutVariable(ep,"A",A);

if(nStatus != 0)

{

cout<<"矩阵变量写入MATLAB引擎空间失败。"<<endl;

exit(EXIT_FAILURE);

}

// 执行引擎命令求矩阵A的逆矩阵

nStatus = engEvalString(ep,"B=inv(A)"); // B=inv(A)为要在MATLAB中运行的命令参数

if(nStatus != 0)

{

cout<<"执行MATLAB引擎命令失败。"<<endl;

exit(EXIT_FAILURE);

}

// 从MATLAB引擎空间中读取执行结果

B = engGetVariable(ep,"B");

// 将矩阵变量B复制到数组arResData中

memcpy((void*)arResData,(void*)mxGetPr(B),sizeof(arResData));

// 释放矩阵变量空间

mxDestroyArray(A);

mxDestroyArray(B);

// 输出计算结果

cout<<"逆矩阵为："<<endl;

for(i = 0; i < 3; i++)

{

for(j = 0; j < 3; j++)

{

cout<<setw(10)<<arResData[i][j]<<" ";

}

cout<<endl;

}

// 暂停程序，查看结果

system("pause");

// 关闭MATLAB引擎

engClose(ep);

}

运行结果如下，可以看到VC中矩阵的行列次序与MATLAB确实正好相反





6. 小结

本文详细的介绍了Matlab引擎使用方法并演示了一个简单的利用VC调用Matlab画图的程序实例。大多数时候，程序员可以利用Matlab强大的数据读写、显示能力和VC编程的高效率。例如，在Matlab中要读入一幅任意格式的图像均只需一条命令i=imread('test.jp');图像数据矩阵便存放在了二维数组i中，可以通过VC读入该数组进行相关处理再调用Matlab显示，这种混合编程方式能大大提高工作效率。

当然，利用VC编译的Matlab引擎程序，运行环境中还必须Matlab的支持，如果要编译完全脱离Matlab的程序，可采用其它方式，如利用第三方Matcom程序编译独立的可执行程序等