【MATLAB】函数设置默认参数

转载自：https://www.xiaowangyun.com/wyblog/detail/?id=130

Matlab函数设置参数默认值

写matlab函数时，通常有些参数会使用默认值，和其他语言不同，matlab有它自己的参数默认值设置方法。

• 在C++/C#/java/python等一系列的语言，甚至是R语言中，给函数设置默认值时都可以通过以下方式来设置：
  • funtionName (param1, param2=defaultValue, ...)
  • 注：一般含默认值的参数放到参数列表的后面。
• 在matlab中，这种方式便行不通了。可以通过以下两种方式给参数设置默认值

  方式1 通过nargin来辅助实现（适用于1-2个较少默认值参数的函数）

  nargin是用来判断输入变量个数的函数，因此可通过判断参数个数来给默认参数赋值，更多nargin详细用法 在matlab窗口中输入help nargin查看帮助文档。

% 第三个参数有默认值
function [result]=funtionName (param1,param2,param3)
    if (nargin<3)
        param3 = defaultValue;
    end
    %函数其他操作
end

方式2 通过inputParser来实现

function [result]=funtionName (varargin)
    param= inputParser;    %接下来设定默认值，还可以指定是必须参数还是可选参数等。
    param.addParamValue('Times', 1);    %其他还有param.addParameter(),param.addRequired()等函数可用
    %函数其他操作   
    %然后将输入的参数进行处理，如果有不同于默认值的那就覆盖掉
    param.parse(varargin{:});
    result=param.Results;
end

若想控制输出方式，可使用nargout输出参数来控制输出

• 综合实例如下

  function [x0, y0] = myplot(x, y, npts, angle, subdiv)
    if nargin < 5, subdiv = 20; end
    if nargin < 4, angle = 10; end
    if nargin < 3, npts = 25; end
    ...
    if nargout == 0
         plot(x, y)
    else
         x0 = x;
         y0 = y;
    end
  end

  参考文献

  • 【matlab】设定函数默认参数
  • MATLAB中nargin函数的用法