matlab和c++混合编程---方法和步骤
matlab和c++混合编程---matlab和vs的环境配置问题
摘要:Matlab具有很强的数值计算和分析等能力,而C/C++是目前最为流行的高级程序设计语言,两者互补结合的混合编程在科学研究和工程实践中具有非常重要的意义。从Matlab调用C/C++代码及C/C++调用m文件两方面,深入地研究了它们之间混合编程的原理和实现机制,并且给出了具体条件下的混合编程方法和步骤。实验表明,给出的Matlab与C/C++混合编程接口及应用方法是有效、实用的。
1引言
Matlab是当前应用最为广泛的数学软件,具有强大的数值计算、数据分析处理、系统分析、图形显示甚至符号运算等功能[1]。利用这一完整的数学平台,用户可以快速实现十分复杂的功能,极大地提高工程分析计算的效率[2][3]。但与其他高级程序[3]相比,Matlab程序是一种解释执行程序,不用编译等预处理,程序运行速度较慢[4]。
C/C++语言是目前最为流行的高级程序设计语言之一[5]。它可对操作系统和应用程序以及硬件进行直接操作,用C/C++语言明显优于其它解释型高级语言,一些大型应用软件如 Matlab 就是用C语言开发的。
在工程实践中,用户经常遇到Matlab与C/C++混合编程的问题。本文基于Matlab 6.5和VC6.0开发环境,在Windows平台下就它们之间的混合编程问题进行深入研究并举例说明。
2 Matlab调用C/C++
Matlab调用C/C++的方式主要有两种:利用MEX技术和调用C/C++动态连接库。
在Matlab与C/C++混合编程之前,必须先对Matlab的编译应用程序mex和编译器mbuild进行正确的设置[1]:
对Matlab编译应用程序mex的设置:Mex –setup.
对Matlab编译器mbuild的设置:Mbuild –setup.
2.1调用C/C++的MEX文件
MEX是Matlab Executable的缩写,它是一种“可在Matlab中调用的C(或Fortran)语言衍生程序”[6]。MEX文件的使用极为方便,其调用方式与Matlab的内建函数完全相同,只需在Matlab命令提示符下键入MEX文件名即可。
一个C/C++的MEX源程序通常包括4个组成部分,其中前3个是必须包含的内容,第4个则根据所实现的功能灵活选用:(1)#include “mex.h”;(2)MEX文件的入口函数mexFunction, MEX文件导出名必须为mexFunction函数;(3)mxArray;(4)API函数
通过简单的例子说明C/C++的MEX源程序编写和调用过程:
#include "mex.h"
void timeSTwo(double y[], double x[])
{ y[0] = 2.0*x[0]; }
void mexFunction(int nlhs, mxArray * plhs[], int nrhs, const mxArray *prhs[])
{
double *x,*y; int mrows, ncols;
if( nrhs!=1) mexErrMsgTxt("One input required.");
else if( nlhs>1) mexErrMsgTxt("Too manyoutput arguments");
mrows = mxGetM( prhs[0] ); ncols = mxGetN(prhs[0]);
if( !mxIsDouble(prhs[0]) || mxIsComplex( prhs[0] ) || !( mrows ==1 && ncols==1 ) )
mexErrMsgTxt( "Input must be a noncomplex scalar double." );
plhs[0] = mxCreateDoubleMatrix ( mrows, ncols, mxREAL );
x = mxGetPr( prhs[0] ); y = mxGetPr( plhs[0] ); timestwo(y,x); }
可在matlab中编译,也可以直接在C++环境中编译:
1).(在matlab中)用指令mex timestwo.c编译此文件,然后在MATLAB命令行下调用生成的MEX文件即可。2). (在VC2008中)和一般c++一样编译后,就会产生dll,这样可以直接在Matlab中用了,或者copy且更改后缀名.mexw32即可。(因为Matlab R2010b以后版本可能不支持调用dll为后缀的mex文件了)
2.2调用C/C++动态连接库(即:一般普通的C程序dll没有用mex的接口函数)
Matlab提供对动态连接库DLL文件的接口[7]。利用该接口,可在Matlab中调用动态连接库导出的函数。Matlab对DLL的接口支持各种语言编写的DLL文件。在调用DLL文件之前,需要准备函数定义的头文件。对于C/C++语言开发的DLL文件,可使用源程序中相应的头文件;而对于其他语言开发的DLL,则要手工准备等效的C语言函数定义头文件。
在Matlab中利用动态连接库接口技术通常需要完成以下4个步骤:
(1)打开动态连接库文件;(2)为调用函数准备数据;(3)调用动态连接库文件中导出的函数;(4)关闭动态连接库文件。
为了实现以上步骤,用到的Matlab函数有:loadlibrary, loadlibrary, calllib, libfunctions, lipointer, libstruct, libisloaded。下面举例说明Matlab调用C/C++动态连接库的方法和步骤:
a.在VC环境下,新建工程->win32动态连接库->工程名Test1->empty工程->完成;
b.新建->C++源文件->添加a.cpp,内容为:#include "a.h"
_declspec(dllexport) int add(int a, int b) { return a+b; }
c.新建->C/C++头文件->添加a.h,内容为: _declspec(dllexport) int add(int a,intb); 然后编译生成Test1.dll动态连接库文件,将Test1.dll和a.h拷到Matlab 工作目录下。
d.在Matlab命令行下,调用Test.dll:>>loadlibrary(‘Test1’,’a.h’); >>x=7;
>>y=8; >>calllib(‘Test1’,‘add’,x,y); Ans=15 >>unloadlibrary(‘Test1’).
调用DLL动态连接库的方法,为Matlab重用工程实践中积累的大量实用C/C++代码提供了一种简洁方便的方法。与调用MEX文件相比,该方法更加简便实用。但是这个接口之支持C,不支持C++库和函数的重载,这种情况下,推荐用MEX-file,若实在要用这种方法(调用C/C++动态连接库),则对于C++要做一些更改,详见http://www.mathworks.de/help/techdoc/matlab_external/f43202.html#bq__4nu-1,
3 C/C++调用Matlab
在工程实践中,C/C++调用Matlab的方法主要有调用Matlab计算引擎、包含m文件转换的C/C++文件,以及调用m文件生成的DLL文件。
3.1利用Matlab计算引擎
Matlab的引擎库为用户提供了一些接口函数,利用这些接口函数,用户在自己的程序中以计算引擎方式调用Matlab文件。该方法采用客户机/服务器的方式,利用Matlab引擎将Matlab和C/C++联系起来。在实际应用中,C/C++程序为客户机,Matlab作为本地服务器。
C/C++程序向Matlab计算引擎传递命令和数据信息,并从Matlab计算引擎接收数据信息[2]。
Matlab提供了以下几个C语言计算引擎访问函数供用户使用[8]:engOpen,engClose, engGetVariable,engPutVariable,engEvalString,engOutputBuffer,engOpenSingleUse, engGetVisible,engSetVisible。
下面以C语言编写的、调用Matlab引擎计算方程x3 ?2x+5=0根的源程序example2.c为例,说明C/C++调用Matlab计算引擎编程的原理和步骤:
#include <windows.h> #include <stdlib.h>
#include <stdio.h> #include "engine.h"
int PASCAL WinMain (HANDLE hInstance, HANDLE hPrevInstance,
LPSTR lpszCmdLine, int nCmdShow )
{
Engine *ep; mxArray *P=NULL,*r=NULL;
char buffer[301]; double poly[4] = { 1,0,-2,5 };
if ( !(ep =engOpen(NULL) ) )
{ fprintf( stderr,"\nCan\'t start MATLAB engine\n" ); return EXIT_FAILURE; }
P = mxCreateDoubleMatrix( 1, 4, mxREAL); mxSetClassName( P, "p" );
memcpy( ( char * ) mxGetPr( P ), (char *) poly, 4*sizeof(double) );
engPutVariable( ep, P ); engOutputBuffer( ep, buffer, 300 );
engEvalString( ep, "disp([\'多项式\',poly2str(p,\'x\'),\'的根\']),r=roots(p)" );
MESSageBox(NULL,buffer,"example2展示MATLAB引擎的应用",MB_OK);
engClose( ep ); mxDestroyArray( P ); return EXIT_SUCCESS;
}
在Matlab下运行example2.exe: mex -f example2.c。运行结果如图1所示:
利用计算引擎调用Matlab的特点是:节省大量的系统资源,应用程序整体性能较好,但不能脱离Matlab的环境运行,且运行速度较慢,但在一些特别的应用[9](例如需要进行三维图形显示)时可考虑使用。
3.2利用mcc编译器生成的cpp 和hpp文件
Matlab自带的C++Complier--mcc,能将m文件转换为C/C++代码。因此,它为C/C++程序调用m文件提供了另一种便捷的方法。下面举例说明相应步骤:
a.新建example3.m: function y=exmaple3(n) y=0; for i=1:n y=y+i; end
保存后在命令窗口中输入:mcc -t -L Cpp -h example3.
则在工作目录下生成example3.cpp和example3.hpp两个文件。
b.在VC中新建一个基于对话框的MFC应用程序Test2,添加一个按钮,并添加按钮响应函数,函数内容见f步。将上面生成的两个文件拷贝到VC工程的Test2目录下。
c.在VC中选择:工程->设置,选择属性表Link选项,下拉菜单中选择Input,在对象 / 库模块中加入lIBMmfile.lib libmatlb.lib libmx.lib libmat.lib libmatpm.lib sgl.lib libmwsglm.lib libmwservices.lib,(后三个为使用Matlab图形库时,需加入)注意用空格分开;而在忽略库中加入 msvcrt.lib;
d.选择属性表C/C++选项,下拉菜单选General,在预处理程序定义中保留原来有的内容,并添加MSVC,IBMPC,MSWIND,并用逗号隔开。选择下拉菜单的Precompiled Headers 选项,在“自动使用预补偿页眉”中添加stdafx.h,然后确定。
e.选择:工具-> 选项,属性页选择“目录”,在include files加入: C:\MATLAB6p5p1\extern\include, C:\MATLAB6p5p1\extern\include\cpp;然后在 Library files里面加入: C:\MATLAB6p5p1\bin\win32, C:\MATLAB6p5p1\extern\ lib\win32\microsoft\msvc60;注意根据用户的Matlab安装位置,修改相应目录。
f.在响应函数中添加头文件:#include "matlab.hpp" #include "example3.hpp"函数响应代码为:
int i; mwArray n; n=10; n=example3(n); i=n.ExtractScalar(1);
CString str; str.Format( "example3的返回值是:%d", I ); AfxMessageBox( str );
g.编译,连接,执行,结果如图2所示。
3.3利用mcc编译器生成的DLL 文件
Matlab的C++ Complier不仅能够将Matlab的m文件转换为C/C++的源代码,还能产生完全脱离Matlab运行环境的独立可执行DLL程序。从而可以在C/C++程序中,通过调用DLL实现对 Matlab代码的调用。下面通过一个简单的例子说明C/C++调用m文件生成的DLL:
a.建立m文件example4.m: function result = example4(para)
x=[1 para 3]; y=[1 3 1]; plot( x,y ); result=para*2; end.然后在命令窗口中输入:
mcc -t -W libhg: example4 -T link: lib -h libmmfile.mlib libmwsglm.mlib example4则在工作目录下会生成example4 .dll、example4 .lib和example4 .h三个文件。
b.在VC中新建一个基于对话框的应用程序Test3,然后添加一个按钮及按钮响应函数,函数内容见d步,再将生成的3个文件拷贝到Test2工程目录下。
c.VC编译环境的设置如同3.2节c、d步;
d.在按钮函数文件添加如下的头文件:#include "example4 .h",函数响应代码为:
mxArray*para=mxCreateDoubleScalar(2); mxArray* result; example4Initialize();
result =mlfExample4(para); CString str;
str.Format( "%f",mxGetScalar(result) ); AfxMessageBox(str);
e.编译,连接,执行,结果如图3所示。
利用mcc编译器生成的DLL动态连接库文件,只需在C/C++编译环境中将其包含进来,调用导出函数即可实现原m文件的功能,极大地方便了用户的代码设计。
4例子
转自:http://sxnuwhui.blog.163.com/blog/static/13706837320124282524436/
让 Matlab调用C函数是通过DLL文件实现的,而这个DLL的开发过程不仅仅可以使用Matlab自带的mex命令,还可以使用VC++开发环境,使用 VC有很多好处,一是让我回到了原来熟悉的开发环境中,二能够使用更加标准的C++编译器,第三点也是最爽的,可以使用VC强大的调试功能。
这里我分四个步骤讲解一个简单的开发过程,使用的Matlab版本为Matlab R2008a,VC版本为Visual C++ 2008 Express版本。
步骤一、新建一个空的dll程序
步骤二、为matlab函数提供头文件和静态库的支持
要让众多的Matlab接口函数能够运行起来,就必须给它们提供头文件和静态库的支持,为了避免每个项目都做这些添加工作,我们可以在Tools|Options|VC++ Directories下将头文件和静态库的目录添加进去,如图:
在Include files中添加”$matlab dir\extern\include”和”$matlab dir\extern\include\win32”,在Library files中添加”$matlab dir\extern\lib\win32\microsoft”。
在项目属性中,让链接器链接libmx.lib、libmat.lib和libmex.lib,如图:
在Preprocessor Definitions中添加MATLAB_MEX_FILE的宏定义。在Project|xx Project Properties|C/C++|Preprocessor中设置,如下图:
现在写一个hello world程序就可以编译通过,如:
第三步 利用def文件导出mexFunction函数
让函数从DLL中的导出有两种方法,__declspec(dllexport)命令导出和def文件导出,但由于需要导出mexFunction在”mex.h”中已经定义,所以前一种导出方法行不通,这里采用def文件导出。
首先告诉编译器我使用了xx.def文件,在Project|xx Project Properties|linker|input|Module Definition File中填上xx.def。
再编写xx.def的内容,只需两句话:
LIBRARY xx
EXPORTS mexFunction
这里的xx指的是模块名称(我用的是我新建的项目名称),并将def文件添加到你的工程中。
最后,将输出文件的后缀名改为mexw32。在Project|xx Project Properties|linker|General|Output File中,如图:
再次编译、生成,可以在生出目录mexw32文件。可以用dumpbin工具查看mexw32文件,可以看到有函数mexFunction已经导出。到这个时候DLL开发已经完成。下一步:
第四步、在启动调试时关联matlab
在Project|xx Project Properties|Debugging|Command里添加Matlab的启动地址:”$matlab dir\bin\win32\MATLAB.exe”。如图:
最后设定断点,启动调试,Matlab会自动启动,运行编写的DLL(mexw32)文件,就会触发断点,如:
当然,最终使用的mexw32文件还应该是Release版本的,这样的话,上面谈的部分设置还需要在Release版本中重新来过。
5结束语
本文从Matlab调用C/C++代码和C/C+调用m文件两方面,详细地研究了Matlab与C/C++混合编程技术。对于Matlab调用C/C++代码,给出了常用的MEX技术和调用C/C++动态连接库的方法,并对它们进行比较。针对用户在实际中经常遇到的C/C++调用Matlab问题,通过研究给出了常用的三种方法及其特点:利用Matlab计算引擎的方法,混合编程后的可执行程序脱离不了Matlab的运行环境,运行速度很慢;利用mcc编译器将m文件转化为C/C++文件的方法,虽然能独立于Matlab运行环境,可在C/C++环境中包含生成的文件非常繁琐;但是m文件生成的DLL为用户提供了一种简洁方便的C/C++调用Matlab代码的方法。除 Matlab自带的mcc外,Matcom 也能将M文件编译为C/C++文件和DLL文件[2][8],但混合编程原理一样,在此省略。
matlab调用c++代码的详细步骤已经在我的另外一篇博客中(matlab和c++混合编程---方法和步骤)说明,这里不再重复。按照它说明的步骤,mex编译一个简单的.cpp文件没有任何问题。但是如果你编译的.cpp文件里面include和lib了一些外部的头文件和静态库,例如用到了opencv库或是某个深度相机的SDK等,还是简单的mex这个cpp文件就会报错,提示找不到某个头文件。这是因为matlab和vs的环境配置没有完成。我就是被这个问题困扰了两天,现在贴出来,以后谨记。
首先,在vs中配置环境。
将你用到的SDK的头文件,静态库和动态库配置好,详细过程参见 vs项目中头文件(.h)静态库(.lib)和 动态库(.dll )的路径和配置问题;
将matlab安装目录下的extern文件夹中的包含文件夹,静态库文件夹配置到vs项目中,例如我的是‘D:\programs installing\matlab2016\extern\include’和‘D:\programs installing\matlab2016\extern\lib\win64\microsoft’,这一步可以参考我转载的博文matlab和c++混合编程---方法和步骤。
然后,在matlab中配置环境。
matlab的环境配置和vs不同,MATLAB里面都是用命令配置编译环境的,第一步,mex -setup,根据提示一步一步来就可以了;第二步,编译,如果是简单的cpp文件,直接mex xxxxxx.cpp就可以了,如果这个.cpp文件里面包含附加依赖项和外部静态库,仅仅简单的mex这个文件就会报错,这时需要在mex这个文件的同时,将用到的外部包含库和静态库添加进去(详细查阅一下mex这个函数的用法),例如我需要将包含目录D:\myo-sdk-win-0.9.0\include,lib目录D:\myo-sdk-win-0.9.0\lib以及lib文件myo32和myo64配置进去,就需要这样命令:mex SEMGStream.cpp -I\'D:\myo-sdk-win-0.9.0\include\' -L\'D:\myo-sdk-win-0.9.0\lib\' -lmyo32 -lmyo64。
需要说明的是,matlab的环境配置跟平时的添加路径不一样,及时你在matlab的设置路径里面将用到的外部库目录添加进去,用mex编译的时候还是会报错,只能通过mex函数的参数进行路径包含,我就是被这个误区困扰了两天,希望看到的朋友避免同样的问题。