argn

Description

This function is used inside a function definition. It gives the number of actual inputs arguments (rhs) and output arguments (lhs) passed to the function when the function is called. It is usually used in function definitions to deal with optional arguments.

Examples

function concat=myOwnFunction(name, optional)
  [lhs,rhs]=argn(0) 
  if rhs <= 1 then
       optional="my Optional value"
  end
  if rhs == 0 then
       error("Expect at least one argument")
  end
  concat=name+" "+optional
endfunction

See Also

• function — opens a function definition
• varargin — variable numbers of arguments in an input argument list