Matlab与C++的混合编程

everysmile

好久没有Coding了，今天兴趣来了，找了一本Matlab与C++嵌入式编程的书翻了翻，想到以后可能也需要用，就觉得尝试着弄了下，这一弄就是大半天过去了，有些问题没有搞清楚，但是也算是开了个头现在写一下收获心得：
Matlab与C++的嵌入方法分为以下三类：
1，Matlab调用C++;将C++代码编译成Mex格式文件，然后在m文件中调用。没有尝试，只是看了描述。
2，C++代码中调用Matlab引擎，这里主要是将Matlab的engine暴露给C++代码进行调用，从而在C++代码中实现Matlab强大的数值计算处理能力；这项也没有尝试，只是看了描述；可参考下面博文
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\R2007a\extern\incl?"。
　　2) 选择“库文件”，添加路径：d:\Program Files\MATLAB\R2007a\extern\lib\win32\microsoft。
　　3) 右击工程/属性，打开项目属性页，选择链接器/输入，在附加依赖项编辑框中，添加文件名libmx.lib libmat.lib libeng.lib。
　　以上步骤1)、2)只需设置一次，而步骤3)对每个项目都要单独设定。
　　3. 引擎API详解
　　在调用Matlab引擎之前，首先应在相关文件中加入一行：#incl? "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窗口中的输出，可以调用engOUtputB?r函数。
　　函数声明：
int engOutputB?r(Engine *ep, char *p, int n);
　　参数ep为Matlab引擎指针，p为用来保存输出结构的缓冲区，n为最大保存的字符个数，通常就是缓冲区p的大小。该函数实行后，接下来的engString函数所引起的命令行输出结果会在缓冲区p中保存。如果要停止保存，只需调用代码：engOutputB?r(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 val);
　　参数ep为打开的Matlab引擎指针，val为是否显示的标志，取值tr（或1）表示显示Matlab窗口，取值false（或0）表示隐藏Matlab窗口。
　　函数返回值为0表示设置成功，为1表示有错误发生。
　　要获得当前Matlab窗口的显示/隐藏情况，可以调用函数：
int engGetVisible(Engine *ep, bool *val);
　　参数ep为打开的Matlab引擎指针，Val为用来保存显示/隐藏情况的变量（采用指针方式传递）。
　　函数返回值为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形式的函数，例如新建一个do le类型数组，可用函数mxCreateDo leMatrix，函数形式如下：
mxArray *mxCreateDo leMatrix(int m, int n, mxComplexity ComplexFlag);
　　参数m和n为矩阵的函数和列数。ComplexFlag为常数，用来区分矩阵中元素是实数还是复数，取值分别为mxREAL和mxCOMPLEX。
　　例如，创建一个3行5列的二维实数数组，可用如下语句：
mxArray *T = mxCreateDo leMatrix(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类型的变量进行操作之前，可以验证以下其中的数组的数据类型，比如是否为do le数组、整数、字符串、逻辑值等，以及是否为某种结构、类、或者是特殊类型，比如是否为空数组，是否为inf、NaN等。常见的判断函数有：


bool mxIsDo le(const mxArray *array_ptr);
bool mxIsComplex(const mxArray *array_ptr);
bool mxIsChar(const mxArray *array_ptr);
bool mxIsEmpty(const mxArray *array_ptr);
bool mxIsInf(do le val);
…… ……


　　这些函数比较简单，意义自明，不再说明。
　　4.2.3 管理mxArray数组的数据
　　对于常用的do le类型的数组，可以用mxGetPr和mxGetPi两个函数分别获得其实部和虚部的数据指针，这两个函数的声明如下：


do le *mxGetPr(const mxArray *array_ptr); //返回数组array_ptr的实部指针
do le *mxGetPi(const mxArray *array_ptr); //返回数组array_ptr的虚部指针


　　这样，就可以通过获得的指针对mxArray类型的数组中的数据进行读写操作。例如可以用函数engGetVariable从Matlab工作空间读入mxArray类型的数组，然后用mxGetPr和mxGetPi获得数据指针，对并其中的数据进行处理，最后调用engPutVariable函数将修改后的数组重新写入到Matlab工作空间。具体实现见第5节程序实例。
5. 程序实例
　　对大部分App研发人员来说利用VC编程方便、高效，但是要显示数据图形就不那么容易了，这时候不防借助Matlab引擎辅助画图做数据分析。下面通过实例演示如何利用VC调用Matlab绘图，程序的主要功能是在VC中对数组x计算函数值y＝sin(x) ±log(x)，然后调用Matlab绘制y对x的图形。
　　在VC中新建工程，编写代码如下：
    #incl? <cstdio>

#incl? <iostream>
#incl? <math.h>
#incl? "engine.h"
using namespace std;
void main()
{
　const int N = 50;
　do le x[N],y[N];
　int j = 1;
　for (int i=0; i<N; i++) //计算数组x和y
　{
　　x = (i+1);
　　y = sin(x) + j * log(x);
　　j *= -1;
　}
　Engine *ep; //定义Matlab引擎指针。
　if (!(ep=engOpen(NULL))) //测试是否启动Matlab引擎成功。
　{
　　cout <<"Can't start Matlab engine!" <<endl;
　　exit(1);
　}
　//定义mxArray，为行，N列的实数数组。
　mxArray *xx = mxCreateDo leMatrix(1,N, mxREAL);
　mxArray *yy = mxCreateDo leMatrix(1,N, mxREAL); //同上。
　memcpy(mxGetPr(xx), x, N*sizeof(do le)); //将数组x复制到mxarray数组xx中。
　memcpy(mxGetPr(yy), y, N*sizeof(do le)); //将数组x复制到mxarray数组yy中。
　engPutVariable(ep, "xx",xx); //将mxArray数组xx写入到Matlab工作空间，命名为xx。
　engPutVariable(ep, "yy",yy); //将mxArray数组yy写入到Matlab工作空间，命名为yy。
　//向Matlab引擎发送画图命令。plot为Matlab的画图函数，参见Matlab相关文档。
　engString(ep, "plot(xx, yy); ");
　mxDestroyArray(xx); //销毁mxArray数组xx和yy。
　mxDestroyArray(yy);
　cout <<"Press any key to exit!" <<endl;
　cin.get();
　engClose(ep); //关闭Matlab引擎。
}



另外一个例子：
#incl? "engine.h"
#incl? <cstdlib>
#incl? <cstring>
#incl?<stdio.h>
//#incl? "matlab.h"
using namespace std;
int main()
{
{
  Engine *ep;
  if(!(ep=engOpen("\0"))) //打开Matlab引擎，建立与本地Matlab的连接
  {
   fprintf(stderr,"\n Can't start MATLAB engine\n");
   exit(-1);
  }
  static do le Areal[6]={1,2,3,4,5,6};
  mxArray *T=NULL,*a=NULL,*d=NULL;
  do le time[10]={0,1,2,3,4,5,6,7,8,9};
  
  T=mxCreateDo leMatrix(1,10,mxREAL);
  memcpy((char*)mxGetPr(T),(char*)time,10*sizeof(do le));
  
  engPutVariable(ep,"T",T);
  
  eng_rString(ep,"D=.5.*(-9.8).*T.^5;");
  eng_rString(ep,"plot(T,D);");
  return 0;
}
}


6. 小结
　　本文详细的先容了Matlab引擎使用方法并演示了一个简单的利用VC调用Matlab画图的程序实例。大多数时候，程序员可以利用Matlab强大的数据读写、显示能力和VC编程的高效率。例如，在Matlab中要读入一幅任意格式的图像均只需一条命令i=imread('test.jp');图像数据矩阵便存放在了二维数组i中，可以通过VC读入该数组进行相关处理再调用Matlab显示，这种混合编程方式能提高工作效率。
　　当然，利用VC编译的Matlab引擎程序，运行环境中还必须Matlab的支撑，如果要编译完全脱离Matlab的程序，可采用其它方式，如利用第三方Matcom程序编译独立的可实行程序等
//参考博文截止
3，C++代码中调用Matlab编译器输出的库函数。这种方式就是在Matlab中将M文件代码编译成可以在C编译器下使用的库函数（有多种库函数形势），然后在C代码中调用。这种方法试过了，调用编译通过了，但有些问题还没有明白解决。主要是参考下面的文章：后面说的注释好像是头文件（博文中看不清楚，我试了一下注释头文件，发现不报错了）
刚开始学习用VC++调用matlab生成的DLL，找了网上一些资料，难以找到vs2008与MATLAB2009b版本的，按照以往版本做的总是有很多错误。经过两天努力，终于调试成功，这里将经验总结一下，以供有需要的人们参考。
实验环境：
Win7
MATLAB 2009b（安装路径：E:\Program Files\MATLAB\R2009a）
VS2008 中文版（安装路径：E:\Program Files\微软 Vis l St io 9.0）
1.Matlab 生成DLL
1.1编译器的安装
在matlab中先安装编译器，我在第一次安装的时候一路y下来，只有一个compiler，还是最老的。这教育大家要学会说N，按照以下步骤操作
>> mbuild -setup
Please choose your compiler for building standalone MATLAB applications:

Would you like mbuild to locate installed compilers [y]/n? n

Select a compiler:
[1] Lcc-win32 C 2.4.1
[2] 微软 Vis l C++ 6.0
[3] 微软 Vis l C++ .NET 2003
[4] 微软 Vis l C++ 2005 SP1
[5] 微软 Vis l C++ 2008 Express
[6] 微软 Vis l C++ 2008 SP1

[0] None

Compiler: 6

The default location for 微软 Vis l C++ 2008 SP1 compilers is C:\Program Files\微软 Vis l St io 9.0,
but that directory does not exist on this machine.

Use C:\Program Files\微软 Vis l St io 9.0 anyway [y]/n? n
Please enter the location of your compiler: [C:\Program Files\微软 Vis l St io 9.0] e:\Program Files\微软 Vis l St io 9.0
（红色部分换成你的vs所安装的地址）
Please verify your choices:

Compiler: 微软 Vis l C++ 2008 SP1
Location: e:\Program Files\微软 Vis l St io 9.0

Are these correct [y]/n? y

****************************************************************************
  Warning: Applications/components generated using 微软 Vis l St io  
           2008 require that the 微软 Vis l St io 2008 run-time      
           libraries be available on the computer used for deployment.      
           To redistribute your applications/components, be sure that the   
           deployment machine has these run-time libraries.                 
****************************************************************************

Trying to update options file: C:\Users\Administrator\AppData\Roaming\MathWorks\MATLAB\R2009a\compopts.bat
From template:              E:\PROGRA~1\MATLAB\R2009a\bin\win32\mbuildopts\msvc90compp.bat

Done . . .

1.2 DLL的生成
首先新建一个m文件，文件名为myadd2.m,定义了一个名为myadd2的函数，代码如下：
//////////////////////////////////////////////////////
function [y,z] = myadd2(a, b)
% dummy function, just to demonstrate the idea
y = a+b;
z = a+2*b;
end
/////////////////////////////////////
在MATLAB命令框中输入以下命令：
mcc -W cpplib:libmyadd2 -T link:lib myadd2.m

生成libmyadd2.lib, libmyadd2.h, libmyadd2.dll 等文件，将这三个文件拷到VS的项目目录下

2. VS调用DLL
2.1 新建一个项目，并设置环境
新建一个win32 控制台应用程序，我取的名字是matlabDll2.当然新建其他的项目类型也可以，我这只是个例子。接下来进行配置，在该项目的属性中进行了配置，只对该项目有效。若建新的项目需要重新配置。项目建好后将libmyadd2.lib, libmyadd2.h, libmyadd2.dll拷贝到项目目录下。
首先配置项目属性页/配置属性/C-C++/常规/附加包含目录，请根据自己电脑上App的安装位置对照设置，2008与2005不同的地方时这里要加两个目录，如下图所示：
其次配置项目属性页/配置属性/链接器/常规/附加库目录，请根据自己电脑上App的安装位置对照设置，如下图所示：
然后配置项目属性页/配置属性/链接器/输入/附加依赖性，填入libmyadd2.lib mclmcrrt.lib mclmcr.lib ，如下图所示：
在这一步俺可吃了大苦头了，有篇文档只说添加前两项，俺就照做了，结果导致运行失败，找了好长时间也没发现错误，两天的功夫都在找，结果就是因为少填了这一项，还有其他的一些包含lib，比如libmex.lib  libmx.lib ,这里没填，好像是VC6上要配的。
配置到此结束
2.2 编写主程序,调试运行
这段代码是从别处拷来的，是一段完整代码，将它粘到matlabDLL2.cpp 主CPP文件中，调试通过：
//////////////////////////////////////////////////////////////////////////////////
#incl? "stdafx.h"
#incl? <iostream>
#incl? "mclmcr.h"
#incl? "mclcppclass.h"
#incl? "libmyadd2.h"

int _tmain(int argc, _TCHAR* argv[])
{
        std::cout << "Hello world!" << std::endl;
        /* Initialize the MCR */
       /* if( !mclInitializeApplication(NULL,0) )
        {
                std::cout << "Could not initialize the application!" << std::endl;
                return -1;
        } */
        // initialize lib
        if( !libmyadd2Initialize())
        {
                std::cout << "Could not initialize libmyadd2!" << std::endl;
                return -1;
        }
        try
        {
        // declare and initialize a
        mwArray a(2, 2,  mxDO LE_CLASS);
        do le *aData;
        aData = new do le[4];
        int i;
        for( i=0; i<4; ++i)
        {
                aData = 1.0*i;
        }
        // print output
        std::cout << "a = " << std::endl;
        std::cout << aData[0] << ",\t" << aData[1] << std::endl;
        std::cout << aData[2] << ",\t" << aData[3] << std::endl;
        a.SetData(aData, 4);
        // declare and initialize b
        mwArray b(2, 2,  mxDO LE_CLASS);
        b(1,1) = 11.;
        b(1,2) = 12.;
        b(2,1) = 21.;
        b(2,2) = 22.;
        mwArray y(2, 2,  mxDO LE_CLASS);
        mwArray z(2, 2,  mxDO LE_CLASS);
        // call the function
                myadd2(2, y, z, a, b);
        // copy data from mwArray to C++ objects
        // allocate outputs
        do le *yData, *zData;
        yData = new do le[4];
        if( yData == NULL )
        {
                std::cout << "Failed to allocate memory for yData!" << std::endl;
                return -1;
        }
        zData = new do le[4];
        if( zData == NULL )
        {
                std::cout << "Failed to allocate memory for zData!" << std::endl;
                return -1;
        }
        // copy data from mwArray to C++
        y.GetData(yData, 4);
        z.GetData(zData, 4);
        // print output
        std::cout << "y = " << std::endl;
        std::cout << yData[0] << ",\t" << yData[1] << std::endl;
        std::cout << yData[2] << ",\t" << yData[3] << std::endl;
        std::cout << "z = " << std::endl;
        std::cout << zData[0] << ",\t" << zData[1] << std::endl;
        std::cout << zData[2] << ",\t" << zData[3] << std::endl;
        
        // deallocate memory
        delete [] aData;
        delete [] zData;
        delete [] yData;
        }
        catch( const mwException& e)
        {
          std::cerr << e.what() << std::endl;
                  
        }
        // terminate the lib
        libmyadd2Terminate();
        // terminate MCR
        mclTerminateApplication();

        return 0;
}