MATLAB中mexFunction函數的接口規範

http://blog.csdn.net/jkhere/article/details/8910311

void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
nlhs:輸出參數數目 
plhs:指向輸出參數的指針 
nrhs:輸入參數數目 
例如,使用
[a,b]=test(c,d,e)
調用mex函數test時,傳給test的這三個參數分別是 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.c 2.0 
#include "mex.h" 
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[]) 
{
int i; 
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.c 2.1 
#include "mex.h" 
void mexFunction(int nlhs, mxArray *plhs[], 
int nrhs, const mxArray *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.c 1.0 
#include "mex.h" 
#include "mex.h" 
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[]) 

double *data; 
int M,N; 
int i,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(int m, int n, mxComplexity ComplexFlag) 
   m:待申請矩陣的行數 
   n:待申請矩陣的列數 
爲矩陣申請內存後,得到的是mxArray類型的指針,就可以放在plhs[]裏傳遞回去了。但是對這個新矩陣的處理,卻要在函數內完成,這時就需要用到前面介紹的mxGetPr。使用 mxGetPr獲得指向這個矩陣中數據區的指針(double類型)後,就可以對這個矩陣進行各種操作和運算了。下面的程序是在上面的show.c的基礎上稍作改變得到的,功能是將輸  
//reverse.c 1.0 
#include "mex.h" 
void mexFunction(int nlhs, mxArray *plhs[], 
    int nrhs, const mxArray *prhs[]) 

double *inData; 
double *outData; 
int M,N; 
int i,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" 
void mexFunction(int nlhs, mxArray *plhs[],  int nrhs, const mxArray *prhs[]) 

double *inData; 
double *outData; 
int M,N; 
//異常處理 
//異常處理 
if(nrhs!=1) 
    mexErrMsgTxt("USAGE: b=reverse(a)\n"); 
  if(!mxIsDouble(prhs[0])) 
   mexErrMsgTxt("the Input Matrix must be double!\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函數的基本過程已經介紹完了。 

原文地址:http://blog.sina.com.cn/s/blog_492dbb6b0100arl2.html


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章