有什么方法可以从mex函数返回可变数量的输出吗?
人们可能会把它们打包到一个单元格中,但我想知道是否有办法,让它们直接在输出列表中展开。类似的东西
a = mymex(arg1, arg2);
[a, b, c] = mymex(arg1, arg2, 'all');
当然可以,就像任何其他MATLAB函数一样:
test_mex.cpp
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
for (int i=0; i<nlhs; i++) {
plhs[i] = mxCreateDoubleScalar(i);
}
}
MATLAB
>> [a,b,c] = test_mex()
a =
0
b =
1
c =
2
您必须根据输入/输出来确定返回多少个参数,或者如果函数调用错误(输入不足、输出过多等),则会发出错误。上面的示例只接受任意数量的输出参数(包括无输出或零输出)
以逗号分隔的列表为例,它允许以有趣的方式调用函数:
>> out = cell(1,20);
>> [out{:}] = test_mex()
out =
Columns 1 through 11
[0] [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
Columns 12 through 20
[11] [12] [13] [14] [15] [16] [17] [18] [19]
这就像调用具有20个输出变量的函数:
>> [x1,x2,...,x20] = test_mex()
编辑:
为了澄清,MEX函数的作用类似于由可变数量的输入和输出定义的正则M-函数(想想function varargout = mymex(varargin)
),并且适用相同的规则;由您来管理对输入的访问并创建必要的输出。
例如,以前的代码可以写成一个常规的M-函数,调用方式与以前相同:
function varargout = test_fcn(varargin)
for i=1:nargout
varargout{i} = i-1;
end
end
不同的是,在MEX文件中,如果你试图访问超出范围的内容,或者试图写入超出实际分配的输出,你可能会使MATLAB崩溃。
举个例子:
#include "mex.h"
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
for (int i=0; i<30; i++) { // <--- note 30 as value
plhs[i] = mxCreateDoubleScalar(i);
}
}
将以上称为:
>> test_mex % careful!
很可能会导致MATLAB立即崩溃。而在M代码中做同样的事情,只会创建不必要的额外输出变量,这些变量在调用后被销毁。
正如@chappjc在回答中解释的那样,对于MEX文件,始终保证至少有一个输出的空间(plhs
是长度至少为1的mxArray*
的数组,因此无论怎样都可以安全地分配plhs[0]
)。如果调用者指定了一个LHS变量,那么输出将进入其中,否则输出将分配给特殊的ans
变量(当然,在零输出的情况下,您仍然可以不分配任何内容)。
幸运的是,MATLAB捕捉到了没有分配足够输出变量的相反情况,并抛出了ID为MATLAB:unassignedOutputs
的规则catch
可执行错误(在MEX和M函数中)。
此外,访问超出范围的输入将导致访问违规(MATLAB将通过一个可怕的大对话框通知您,提示将变为"请重新启动MATLAB"消息)。在常规M代码中做同样的操作,只会抛出一个常规错误"Index exceeds matrix dimensions."
,没什么大不了的!
正如您所看到的,在MEX世界中,事情很容易出错(以不可恢复的方式),所以您必须特别注意验证输入/输出参数。
调用MEX函数的语法与任何其他MATLAB函数相同。然而,在MEX函数内部,使用的输入/输出参数的数量由mexFunction
的第一个和第三个参数决定(通常命名为nlhs
和nrhs
,可以是任何值)。
mex.h
中mexFunction
的声明(R2014b中141行附近):
/*
* mexFunction is the user-defined C routine that is called upon invocation
* of a MEX-function.
*/
void mexFunction(
int nlhs, /* number of expected outputs */
mxArray *plhs[], /* array of pointers to output arguments */
int nrhs, /* number of inputs */
const mxArray *prhs[] /* array of pointers to input arguments */
);
这与C/C++命令行可执行文件的标准main
函数的语法没有什么不同,但存在显著差异。与本机命令行版本(int main(int argc, const char* argv[])
)不同,计数和指针数组不包括函数的名称(argv[0]
通常是可执行程序文件的名称),mexFunction
有用于输出参数和输入的参数。
nlhs
和nrhs
的命名应该很清楚。提示:在数学中,一个方程有一个lefth和side和一个
ighthandsid。
mexFunction
I/O处理的一个重要但容易被忽视的质量与MATLAB的特殊ans
变量有关,如果不给变量赋值,函数输出(经常)会出现在这个地方。在MEX文件中,检查nlhs
时需要记住以下内容如果是nlhs=0
,则您可以并且仍然必须写入plhs[0]
才能使用ans
在MEX文件的数据流中几乎没有记录。考虑以下代码会发生什么:
// test_nlhs.cpp
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
for (int i=0; i<nlhs; ++i)
plhs[i] = mxCreateDoubleScalar(i);
}
输出:
>> test_nlhs
>> [a,b] = test_nlhs
a =
0
b =
1
没有输出到ans
,因为nlhs
的逻辑阻止它分配到plhs[0]
。现在这个代码:
// test_nlhs.cpp
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
if (nlhs==0) {
mexPrintf("Returning special value to ""one_answers"".n");
plhs[0] = mxCreateDoubleScalar(-1);
} else {
mexPrintf("Returning to specified workspace variables.n");
for (int i=0; i<nlhs; ++i)
plhs[i] = mxCreateDoubleScalar(i);
}
}
输出
>> test_nlhs
Returning special value to ans.
ans =
-1
>> [a,b] = test_nlhs
Returning to specified workspace variables.
a =
0
b =
1
它当然不一定是一个特殊的值,它通常应该是相同的第一个输出参数,但我正在说明如何识别调用语法。