為了測試你的路徑設定正確與否,把下面的程式存為hello.c。
/*hello.c*/
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
{mexPrintf("hello,world!\n");
}
假設你把hello.c放在了C:\TEST\下,在Matlab裡用CDC:\TEST\將當前目錄改為C:\TEST\(注意,僅將C:\TEST\加入搜尋路徑是沒有用的)。現在敲:
mexhello.c
如果一切順利,編譯應該在出現編譯器提示資訊後正常退出。如果你已將C:\TEST\加
入了搜尋路徑,現在鍵入hello,程式會在螢幕上打出一行:
hello,world!
看看C\TEST\目錄下,你會發現多了一個檔案:HELLO.DLL。這樣,第一個mex函式就算完成了。分析hello.c,可以看到程式的結構是十分簡單的,整個程式由一個介面子過程mexFunction構成。
前面提到過,Matlab的mex函式有一定的介面規範,就是指這
nlhs:輸出引數數目
plhs:指向輸出引數的指標
nrhs:輸入引數數目
例如,使用
[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.c2.0
{
inti;
i=mxGetScalar(prhs[0]);
if(i==1)
mexPrintf("hello,world!\n");
else
mexPrintf("大家好!\n");
將這個程式編譯通過後,執行hello(1),螢幕上會打出:
而hello(0)將會得到:
大家好!
現在,程式hello已經可以根據輸入引數來給出相應的螢幕輸出。在這個程式裡,除了用到了螢幕輸出函式mexPrintf(用法跟c裡的printf函式幾乎完全一樣)外,還用到了一個函式:mxGetScalar,呼叫方式如下:
"Scalar"就是標量的意思。在Matlab裡資料都是以陣列的形式存在的,mxGetScalar的作用就是把透過prhs[0]傳遞進來的mxArray型別的指標指向的資料(標量)賦給C程式裡的變數。這個變數本來應該是double型別的,透過強制型別轉換賦給了整形變數i。既然有標量,顯然還應該有向量,否則矩陣就沒法傳了。看下面的程式:
//hello.c2.1
voidmexFunction(intnlhs,mxArray*plhs[],
intnrhs,constmxArray*prhs[])
int*i;
i=mxGetPr(prhs[0]);
if(i[0]==1)
這樣,就透過mxGetPr函式從指向mxArray型別資料的prhs[0]獲得了指向double型別的指標。
但是,還有個問題,如果輸入的不是單個的資料,而是向量或矩陣,那該怎麼處理呢?透過mxGetPr只能得到指向這個矩陣的指標,如果我們不知道這個矩陣的確切大小,就
沒法對它進行計算。
為了解決這個問題,Matlab提供了兩個函式mxGetM和mxGetN來獲得傳進來引數的行數和列數。下面例程的功能很簡單,就是獲得輸入的矩陣,把它在螢幕上顯示出來:
//show.c1.0
double*data;
intM,N;
inti,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)
需要注意的是,在Matlab裡,矩陣第一行是從1開始的,而在C語言中,第一行的序數為零,Matlab裡的矩陣元素b(i,j)在傳遞到C中的一維陣列大data後對應於data[j*M+i]。
輸入資料是在函式呼叫之前已經在Matlab裡申請了記憶體的,由於mex函式與Matlab共用同一個地址空間,因而在prhs[]裡傳遞指標就可以達到引數傳遞的目的。但是,輸出引數卻需要在mex函式內申請到記憶體空間,才能將指標放在plhs[]中傳遞出去。由於返回指標型別必須是mxArray,所以Matlab專門提供了一個函式:mxCreateDoubleMatrix來實現記憶體的申請,函式原型如下:
mxArray*mxCreateDoubleMatrix(intm,intn,mxComplexityComplexFlag)
m:待申請矩陣的行數
n:待申請矩陣的列數
為矩陣申請記憶體後,得到的是mxArray型別的指標,就可以放在plhs[]裡傳遞回去了。但是對這個新矩陣的處理,卻要在函式內完成,這時就需要用到前面介紹的mxGetPr。使用mxGetPr獲得指向這個矩陣中資料區的指標(double型別)後,就可以對這個矩陣進行各種操作和運算了。下面的程式是在上面的show.c的基礎上稍作改變得到的,功能是將輸
//reverse.c1.0
double*inData;
double*outData;
inData=mxGetPr(prhs[0]);
M=mxGetM(prhs[0]);
N=mxGetN(prhs[0]);
plhs[0]=mxCreateDoubleMatrix(M,N,mxREAL);
outData=mxGetPr(plhs[0]);
for(j=0;j<N;j++)
outData[j*M+i]=inData[(N-1-j)*M+i];
當然,Matlab裡使用到的並不是只有double型別這一種矩陣,還有字串型別、稀疏矩陣、結構型別矩陣等等,並提供了相應的處理函式。本文用到編制mex程式中最經常遇到的一些函式,其餘的詳細情況清參考Apiref.pdf。
透過前面兩部分的介紹,大家對引數的輸入和輸出方法應該有了基本的瞭解。具備了這些知識,就能夠滿足一般的程式設計需要了。但這些程式還有些小的缺陷,以前面介紹的re由於前面的例程中沒有對輸入、輸出引數的數目及型別進行檢查,導致程式的容錯性很差,以下程式則容錯性較好
//異常處理
if(nrhs!=1)
mexErrMsgTxt("USAGE:b=reverse(a)\n");
if(!mxIsDouble(prhs[0]))
mexErrMsgTxt("theInputMatrixmustbedouble!\n");
在上面的異常處理中,使用了兩個新的函式:mexErrMsgTxt和mxIsDouble。MexErrMsgTxt在給出出錯提示的同時退出當前程式的執行。MxIsDouble則用於判斷mxArray中的資料是否double型別。當然Matlab還提供了許多用於判斷其他資料型別的函式,這裡不加詳述。
需要說明的是,Matlab提供的API中,函式字首有mex-和mx-兩種。帶mx-字首的大多是對mxArray資料進行操作的函式,如mxIsDouble,mxCreateDoubleMatrix等等。而帶mx字首的則大多是與Matlab環境進行互動的函式,如mexPrintf,mxErrMsgTxt等等。瞭解了這一點,對在Apiref.pdf中查詢所需的函式很有幫助。
至此為止,使用C編寫mex函式的基本過程已經介紹完了。
為了測試你的路徑設定正確與否,把下面的程式存為hello.c。
/*hello.c*/
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
{mexPrintf("hello,world!\n");
}
假設你把hello.c放在了C:\TEST\下,在Matlab裡用CDC:\TEST\將當前目錄改為C:\TEST\(注意,僅將C:\TEST\加入搜尋路徑是沒有用的)。現在敲:
mexhello.c
如果一切順利,編譯應該在出現編譯器提示資訊後正常退出。如果你已將C:\TEST\加
入了搜尋路徑,現在鍵入hello,程式會在螢幕上打出一行:
hello,world!
看看C\TEST\目錄下,你會發現多了一個檔案:HELLO.DLL。這樣,第一個mex函式就算完成了。分析hello.c,可以看到程式的結構是十分簡單的,整個程式由一個介面子過程mexFunction構成。
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
前面提到過,Matlab的mex函式有一定的介面規範,就是指這
nlhs:輸出引數數目
plhs:指向輸出引數的指標
nrhs:輸入引數數目
例如,使用
[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.c2.0
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
{
inti;
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.c2.1
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],
intnrhs,constmxArray*prhs[])
{
int*i;
i=mxGetPr(prhs[0]);
if(i[0]==1)
mexPrintf("hello,world!\n");
else
mexPrintf("大家好!\n");
}
這樣,就透過mxGetPr函式從指向mxArray型別資料的prhs[0]獲得了指向double型別的指標。
但是,還有個問題,如果輸入的不是單個的資料,而是向量或矩陣,那該怎麼處理呢?透過mxGetPr只能得到指向這個矩陣的指標,如果我們不知道這個矩陣的確切大小,就
沒法對它進行計算。
為了解決這個問題,Matlab提供了兩個函式mxGetM和mxGetN來獲得傳進來引數的行數和列數。下面例程的功能很簡單,就是獲得輸入的矩陣,把它在螢幕上顯示出來:
//show.c1.0
#include"mex.h"
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
{
double*data;
intM,N;
inti,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)
需要注意的是,在Matlab裡,矩陣第一行是從1開始的,而在C語言中,第一行的序數為零,Matlab裡的矩陣元素b(i,j)在傳遞到C中的一維陣列大data後對應於data[j*M+i]。
輸入資料是在函式呼叫之前已經在Matlab裡申請了記憶體的,由於mex函式與Matlab共用同一個地址空間,因而在prhs[]裡傳遞指標就可以達到引數傳遞的目的。但是,輸出引數卻需要在mex函式內申請到記憶體空間,才能將指標放在plhs[]中傳遞出去。由於返回指標型別必須是mxArray,所以Matlab專門提供了一個函式:mxCreateDoubleMatrix來實現記憶體的申請,函式原型如下:
mxArray*mxCreateDoubleMatrix(intm,intn,mxComplexityComplexFlag)
m:待申請矩陣的行數
n:待申請矩陣的列數
為矩陣申請記憶體後,得到的是mxArray型別的指標,就可以放在plhs[]裡傳遞回去了。但是對這個新矩陣的處理,卻要在函式內完成,這時就需要用到前面介紹的mxGetPr。使用mxGetPr獲得指向這個矩陣中資料區的指標(double型別)後,就可以對這個矩陣進行各種操作和運算了。下面的程式是在上面的show.c的基礎上稍作改變得到的,功能是將輸
//reverse.c1.0
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],
intnrhs,constmxArray*prhs[])
{
double*inData;
double*outData;
intM,N;
inti,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];
}
當然,Matlab裡使用到的並不是只有double型別這一種矩陣,還有字串型別、稀疏矩陣、結構型別矩陣等等,並提供了相應的處理函式。本文用到編制mex程式中最經常遇到的一些函式,其餘的詳細情況清參考Apiref.pdf。
透過前面兩部分的介紹,大家對引數的輸入和輸出方法應該有了基本的瞭解。具備了這些知識,就能夠滿足一般的程式設計需要了。但這些程式還有些小的缺陷,以前面介紹的re由於前面的例程中沒有對輸入、輸出引數的數目及型別進行檢查,導致程式的容錯性很差,以下程式則容錯性較好
#include"mex.h"
voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[])
{
double*inData;
double*outData;
intM,N;
//異常處理
//異常處理
if(nrhs!=1)
mexErrMsgTxt("USAGE:b=reverse(a)\n");
if(!mxIsDouble(prhs[0]))
mexErrMsgTxt("theInputMatrixmustbedouble!\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];
}
在上面的異常處理中,使用了兩個新的函式:mexErrMsgTxt和mxIsDouble。MexErrMsgTxt在給出出錯提示的同時退出當前程式的執行。MxIsDouble則用於判斷mxArray中的資料是否double型別。當然Matlab還提供了許多用於判斷其他資料型別的函式,這裡不加詳述。
需要說明的是,Matlab提供的API中,函式字首有mex-和mx-兩種。帶mx-字首的大多是對mxArray資料進行操作的函式,如mxIsDouble,mxCreateDoubleMatrix等等。而帶mx字首的則大多是與Matlab環境進行互動的函式,如mexPrintf,mxErrMsgTxt等等。瞭解了這一點,對在Apiref.pdf中查詢所需的函式很有幫助。
至此為止,使用C編寫mex函式的基本過程已經介紹完了。