matlab - 从 mex 函数返回可变数量的输出

Question

有没有办法从 mex 函数返回可变数量的输出？

有人可能会将它们打包到一个单元格中，但我想知道是否有一种方法可以让它们直接在输出列表中展开。有点像

a = mymex(arg1, arg2);

[a, b, c] = mymex(arg1, arg2, 'all');

Answer 1

当然可以，就像任何其他 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 是 mxArray* 的数组长度至少为 1，因此无论如何分配 plhs[0] 都是安全的)。如果调用者指定了一个 LHS 变量，则输出进入它，否则输出被分配给特殊的 ans 变量(当然你仍然可以不分配任何东西，以防输出为零)。

幸运的是，未分配足够输出变量的相反情况被 MATLAB 捕获，并抛出 ID 为 MATLAB:unassignedOutputs 的常规 catch 错误(在 MEX 和M 函数)。

此外，访问超出范围的输入将导致访问冲突(MATLAB 将通过一个可怕的大对话框通知您，并且提示将变为“请重新启动 MATLAB”消息)。在常规 M 代码中执行相同操作，只会抛出常规错误 “Index exceeds matrix dimensions.”，没什么大不了的!

如您所见，在 MEX 世界中很容易出错(以不可恢复的方式)，因此您必须特别注意验证输入/输出参数。