Exponenta Banner

parse

Анализ входных параметров функции

свернуть все на странице

Синтаксис

parse(p,argList)

Описание

пример

parse(p,argList) синтаксические анализы и подтверждают входные параметры в arglist.

Примеры

свернуть все

Создайте входную схему синтаксического анализатора, которая проверяет, что необходимый вход является неотрицательным, числовым скаляром. Синтаксис @(x) создает указатель на анонимную функцию с одним входом.

p = inputParser;
argName = 'num';
validationFcn = @(x) (x > 0) && isnumeric(x) && isscalar(x);
addRequired(p,argName,validationFcn)

Проанализируйте недопустимый вход, такой как -1:

parse(p,-1)
The value of 'num' is invalid. It must satisfy the function: @(x)(x>0)&&isnumeric(x)&&isscalar(x).

Проанализируйте и подтвердите требуемые и дополнительные входные параметры функции.

Создайте функцию в файле findArea.m. findArea функция требует width входной параметр и принимает переменное количество дополнительных входных параметров. Входная схема синтаксического анализатора задает эти условия аргумента:

  • width (обязательный аргумент). Поскольку обязательные аргументы позиционны, width должен быть первый аргумент к findArea функция. Входной синтаксический анализатор проверяет тот width является положительным, скалярным, и числовым.

  • height (дополнительный аргумент). Поскольку дополнительные аргументы позиционны, если height аргумент к findArea функция, затем это должен быть второй аргумент. Входной синтаксический анализатор проверяет тот height является положительным, скалярным, и числовым.

  • 'units' и его присваиваемое значение (пара "имя-значение"). Пары "имя-значение" являются дополнительными. Когда вы вызываете findArea функционируйте, задайте пары "имя-значение" в любом порядке после позиционных параметров. Входной синтаксический анализатор проверяет что значение на 'units' строка.

  • 'shape' и его присваиваемое значение (другая пара "имя-значение"). Входной синтаксический анализатор проверяет что значение на 'shape' содержится в expectedShapes массив.

function a = findArea(width,varargin)
   defaultHeight = 1;
   defaultUnits = 'inches';
   defaultShape = 'rectangle';
   expectedShapes = {'square','rectangle','parallelogram'};

   p = inputParser;
   validScalarPosNum = @(x) isnumeric(x) && isscalar(x) && (x > 0);
   addRequired(p,'width',validScalarPosNum);
   addOptional(p,'height',defaultHeight,validScalarPosNum);
   addParameter(p,'units',defaultUnits,@isstring);
   addParameter(p,'shape',defaultShape,...
                 @(x) any(validatestring(x,expectedShapes)));
   parse(p,width,varargin{:});
   
   a = p.Results.width*p.Results.height; 
end

Вызовите findArea функционируйте несколько раз. Входной синтаксический анализатор не выдает ошибку ни для одного из этих вызовов функции.

a = findArea(7);
a = findArea(7,3);
a = findArea(13,'shape','square');
a = findArea(13,'units',"miles",'shape','square');

Вызовите функцию с аргументами, которые не совпадают с входной схемой синтаксического анализатора. Задайте нечисловое значение для width входной параметр:

a = findArea('text')
Error using findArea (line 14)
The value of 'width' is invalid. It must satisfy the function: @(x)isnumeric(x)&&isscalar(x)&&(x>0).

Задайте неподдерживаемое значение для 'shape'.

a = findArea(4,12,'shape','circle')
Error using findArea (line 14)
The value of 'shape' is invalid. Expected input to match one of these values:

'square', 'rectangle', 'parallelogram'

The input, 'circle', did not match any of the valid values.

Входные параметры

свернуть все

Введите схему синтаксического анализатора в виде inputParser объект.

Входные параметры, чтобы проанализировать и подтвердить в виде списка, разделенного запятыми. Элементы argList может быть любой тип данных. Входной синтаксический анализатор определяет валидность аргумента с помощью функции валидации, которую вы задали, когда вы добавили аргументы во входную схему синтаксического анализатора.

Пример: 'textA',13,mtxB

Пример: varargin{:}

Смотрите также

| | |

Представленный в R2007a

Документация MATLAB
Поддержка