Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

varargin

可变长度输入参数列表

语法

描述

示例

varargin 是函数定义语句中的一个输入变量,允许函数接受任意数量的输入参数。使用小写字符指定 varargin。在任何显式声明的输入项后,附加 varargin 作为最后一个输入参数。

在执行函数时,varargin 是一个 1×N 元胞数组,其中 N 是函数在显式声明的输入后收到的输入项数。如果该函数在显式声明的输入后未收到任何输入,则 varargin 是空元胞数组。

示例

全部展开

在名称为 acceptVariableNumInputs.m 的文件中定义一个函数,接受个数不定的输入项,并显示每个输入项的值。

type acceptVariableNumInputs
function acceptVariableNumInputs(varargin)
    disp("Number of input arguments: " + nargin)
    celldisp(varargin)
end

使用多个输入调用该函数。

acceptVariableNumInputs(ones(3),'some text',pi)
Number of input arguments: 3
 
varargin{1} =
 
     1     1     1
     1     1     1
     1     1     1

 
 
varargin{2} =
 
some text
 
 
varargin{3} =
 
    3.1416

 

在名为 definedAndVariableNumInputs.m 的文件中定义一个函数,它有两个必需的输入,并且接受一定数量的附加输入。

type definedAndVariableNumInputs
function definedAndVariableNumInputs(X,Y,varargin)
    disp("Total number of input arguments: " + nargin)
    
    formatSpec = "Size of varargin cell array: %dx%d";
    str = compose(formatSpec,size(varargin));
    disp(str)

end

使用多个输入调用该函数。

definedAndVariableNumInputs(7,pi,rand(4),datetime('now'),'hello')
Total number of input arguments: 5
Size of varargin cell array: 1x3

使用两个输入调用该函数。varargin 是空元胞数组。

definedAndVariableNumInputs(13,42)
Total number of input arguments: 2
Size of varargin cell array: 0x0

在名为 variableNumInputAndOutput.m 的文件中定义一个函数,它接受可变数目的输入和输出。

type variableNumInputAndOutput
function varargout = variableNumInputAndOutput(varargin)
    disp(['Number of provided inputs: ' num2str(length(varargin))])
    disp(['Number of requested outputs: ' num2str(nargout)])
    
    for k = 1:nargout
        varargout{k} = k;
    end
end

使用两个输入和三个输出调用该函数。

[d,g,p] = variableNumInputAndOutput(6,'Nexus')
Number of provided inputs: 2
Number of requested outputs: 3
d = 1
g = 2
p = 3

不使用任何输入和输出再次调用该函数。

variableNumInputAndOutput
Number of provided inputs: 0
Number of requested outputs: 0

扩展功能

版本历史记录

在 R2006a 之前推出

全部展开