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

时间:2014-10-20 08:03:13

标签: matlab return-value mex

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

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

这样的东西
a = mymex(arg1, arg2);

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

2 个答案:

答案 0 :(得分:5)

当然,您可以像任何其他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为catch的常规MATLAB:unassignedOutputs错误(在MEX和M函数中)。

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

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

答案 1 :(得分:2)

调用MEX函数的语法与任何其他MATLAB函数相同。但是,在MEX函数内部,使用的输入/输出参数的数量由mexFunction的第一个和第三个参数确定(通常命名为nlhsnrhs,可以是任何东西)。

mexFunction mex.h的声明(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[]))不同,count和pointer数组不包含函数的名称(argv[0]通常是可执行程序文件的名称),并且{{1}输出参数和输入都有参数。

mexFunctionnlhs的命名应该清楚。提示:在数学中,等式具有 l eft h s ide以及 r ight h s ide。


一个重要但容易被忽视的nrhs I / O处理质量属于MATLAB的特殊mexFunction变量,如果你没有,函数输出(经常)的地方就是分配给变量。在MEX文件中,检查ans时需要记住以下内容。 如果nlhs,您可以而且仍然必须写信至nlhs=0才能使用plhs[0]它已在{{3 }}。考虑以下代码会发生什么:

ans

输出:

// 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 ""ans"".\n");
        plhs[0] = mxCreateDoubleScalar(-1);
    } else {
        mexPrintf("Returning to specified workspace variables.\n");
        for (int i=0; i<nlhs; ++i)
            plhs[i] = mxCreateDoubleScalar(i);
    }
}

它当然不一定是一个特殊的值,它通常应该是相同的第一个输出参数,但是我会说明你如何识别它调用语法。