В этом разделе показаны способы задать функции валидации, которые вы передаете в Входе Parser для проверки пользовательских входных параметров функции.
Методы входного анализатора addRequired
, addOptional
, и addParameter
каждый принимает необязательный указатель на функцию валидации. Обозначите указатели на функцию как at (@
) символ.
Функции валидации должны принять один входной параметр, и они должны либо вернуть скалярное логическое значение (true
или false
) или ошибка. Если функция валидации возвращается false
, Input Parser выдает ошибку, и ваша функция останавливает обработку.
Существует несколько способов определения функций валидации:
Использование существующего MATLAB® функция, такая как ischar
или isnumeric
. Например, проверяйте, что необходимый вход с именем num
является числовым:
p = inputParser; checknum = @isnumeric; addRequired(p,'num',checknum) parse(p,'text')
The value of 'num' is invalid. It must satisfy the function: isnumeric.
Создайте анонимную функцию. Для примера проверьте этот вход num
является числовым скаляром, большим нуля:
p = inputParser;
checknum = @(x) isnumeric(x) && isscalar(x) && (x > 0);
addRequired(p,'num',checknum)
parse(p,rand(3))
The value of 'num' is invalid. It must satisfy the function: @(x) isnumeric(x) && isscalar(x) && (x>0).
Определите свою собственную функцию, обычно локальную функцию в том же файле, что и вашу первичную функцию. Для примера в файле с именем usenum.m
, задайте локальную функцию с именем checknum
который выдает пользовательские сообщения об ошибке, когда вход num
на usenum
не является числовым скаляром, большим нуля:
function usenum(num) p = inputParser; addRequired(p,'num',@checknum); parse(p,num); function TF = checknum(x) TF = false; if ~isscalar(x) error('Input is not scalar'); elseif ~isnumeric(x) error('Input is not numeric'); elseif (x <= 0) error('Input must be > 0'); else TF = true; end
Вызовите функцию с недопустимым входом:
usenum(-1)
Error using usenum (line 4) The value of 'num' is invalid. Input must be > 0
inputParser
| is*
| validateattributes