varargin

Description

A function whose last input argument is varargin can be called with more input arguments than indicated in the input argument list. The calling arguments passed form varargin keyword onwards may then be retrieved within the function in a list named varargin.

Suppose that varargin keyword is the n-th argument of the formal input argument list, then if the function is called with less than n-1 input arguments the varargin list is not defined, if the function is called with n-1 arguments then varargin list is an empty list.

function y = ex(varargin) may be called with any number of input arguments. Within function ex input arguments may be retrieved in varargin(i), i=1:length(varargin).

If it is not the last input argument of a function, varargin is a normal input argument name with no special meaning.

The total number of actual input arguments is given by argn(2).

Remark

Named argument syntax like foo(...,key=value) is incompatible with the use of varargin. The reason is that the names (i.e. keys) associated with values are not stored in the varargin list. Consider for instance:

function foo(varargin)
    disp([varargin(1),varargin(2)])
endfunction

--> foo(a=1, b=2)
 1.    2.
--> foo(b=1, a=2)
 1.    2.

Result is the same, but the arguments were inverted.

Examples

function exampl(a, varargin)
    [lhs,rhs]=argn(0)
    if rhs>=1 then
        disp(varargin)
    end
endfunction

exampl(1)
exampl()
exampl(1,2,3)
l=list('a',%s,%t);
exampl(1,l(2:3))

See also

• argn — Returns the actual number of input/output arguments in a function call
• function — opens a function definition
• list — a Scilab object and a list definition function
• varargout — variable numbers of arguments in an output argument list