虽然nargin
已经给出了解决方案,并且在大多数 MATLAB 代码库中或多或少是标准用法,但我认为有一个更好的替代方案,更具可读性。
在nargin
大函数中,你必须记住参数 3 到底是什么。特别是如果您有更多可选参数,那么跟踪或允许传递一些可选参数而其他的则不是很麻烦。
第一个也是更简单的解决方案是我个人的替代方案nargin
,即使用以下exist
功能:
function [output] = getValue(modelName,param,option, otherOption)
if ~exist('option', 'var') || isempty(option)
option = 'defaultValueForOption';
end
if ~exist('otherOption', 'var') || isempty(otherOption)
otherOption = 'defaultValueForOption';
end
% perform other actions
优点是现在所有与输入相关的代码都在开头,并且对于应该发生的事情更加详细。你不会用那种逻辑弄乱你的其他代码。您还可以if
通过输入验证来补充这些语句,并在给出无效选项时回退到默认值。
另一种可能性是更高版本的 MATLAB 中的标准:inputParser
类。使用这个类,您可以定义更复杂的可选参数甚至键值对的场景。
下面是一个自我描述的示例,我一直保留以避免每次都需要文档。
%% Usage Example input Parser
%
function output = FuncName(rParam1, rParam2, oParam1, oParam2, varargin)
p = inputParser();
defaultValue = 0;
validatorFunc = @(x)(true); % validator function should return true when x is valid
%% Input Format definition
p.addRequired('rParam1', validatorFunc);
p.addRequired('rParam2', validatorFunc);
p.addOptional('oParam1', defaultValue, validatorFunc);
p.addOptional('oParam2', defaultValue, validatorFunc);
p.addParamValue('kvParam1', defaultValue, validatorFunc);
p.addParamValue('kvParam2', defaultValue, validatorFunc);
p.addParamValue('kvParam3', defaultValue, validatorFunc);
p.addParamValue('kvParam4', defaultValue, validatorFunc)
%% Optional Settings
% expand supplied struct to ParamValue pairs (or other arguments)
p.StructExpand = true; % default: false
%% Parse
p.parse(rParam1, rParam2, oParam1, oParam2, varargin{:})
%% Retrieve results
values = p.Results(); % structure with all values
defaultedArgs = p.UsingDefaults; % cell array of all parameter names using defaults
end
这种方法更加冗长而且就个人而言,我不太喜欢这样一个事实,即必须为每个输入重新定义它是必需的还是可选的,并且它需要大量的样板代码。但至少,它是一个标准解决方案,毫无疑问是大型功能的首选解决方案。
与检查方式相比,这两种方法都存在一个缺点nargin
:它们都比较慢。因此,如果您在经常调用的函数中使用这些(或仅执行非常快速的计算),那么使用它可能更值得nargin
。