Add function argument validation for optional parameters based on the values of required parameters

Question

hmhuang 2022-2-23

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/1656410-add-function-argument-validation-for-optional-parameters-based-on-the-values-of-required-parameters

回答： Steven Lord 2022-2-23

I have a function signature like this:

function MyFunc(a, b, options)
%% Function argument validation
arguments
    %% @Required parameters:
    a (1,1) {mustBeInteger, mustBePositive}
    b (1,1) {mustBeInteger, mustBePositive}
    %% @Optional parameters:
    options.n_bar (1,1) {mustBeInteger, mustBeLessThanOrEqual(options.n_bar, a*b*2)} % !!!Error!!!
end
% ... Function body of MyFunc goes here ...

I would like to add a constraint on options.n_bar based on the values of a and b, such that options.n_bar <= a*b*2. I tried to achieve that as shown in the above code snippet, but MATLAB didn't allow me to do that in this way. How can I make it work?

1 个评论
显示 -1更早的评论隐藏 -1更早的评论

hmhuang 2022-2-23

Any thoughts?

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

Steven Lord 2022-2-23

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/1656410-add-function-argument-validation-for-optional-parameters-based-on-the-values-of-required-parameters#answer_902635

在 MATLAB Online 中打开

Write your own local function that accepts n_bar, a, and b and performs the validation and use that local function as your validation function. This way your validation doesn't depend on the output of a function call (the * operator aka the mtimes function.)

MyFunc(1, 2) % Use the default of a*b*2
    n_bar: 4
MyFunc(1, 2, 'n_bar', 5) % Error
Error using solution>MyFunc (line 10)
Invalid name-value argument 'n_bar'. Value must be less than or equal to 4.
function MyFunc(a, b, options)
%% Function argument validation
arguments
    %% @Required parameters:
    a (1,1) {mustBeInteger, mustBePositive}
    b (1,1) {mustBeInteger, mustBePositive}
    %% @Optional parameters:
    options.n_bar (1,1) {mustBeInteger, validate_n_bar(options.n_bar, a, b)} = a*b*2;
end
% ... Function body of MyFunc goes here ...
disp(options)
end
function validate_n_bar(n_bar, a, b)
mustBeLessThanOrEqual(n_bar, a*b*2);
end