Exponenta Banner

addParamValue

(Не рекомендуемый), Добавляет дополнительный аргумент пары "имя-значение" во входную схему синтаксического анализатора

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

addParamValue не рекомендуется. Используйте addParameter вместо этого.

Синтаксис

addParamValue(p,paramName,defaultVal)
addParamValue(p,paramName,defaultVal,validationFcn)

Описание

пример

addParamValue(p,paramName,defaultVal) добавляет название параметра дополнительного аргумента пары "имя-значение" во входную схему синтаксического анализатора. Когда входные параметры к функции не включают эту дополнительную пару "имя-значение", входной синтаксический анализатор присваивает paramName значение defaultVal.

В отличие от позиционных входных параметров, добавленных с addRequired и addOptional функции, каждый параметр, добавленный с addParamValue соответствует двум входным параметрам: один для имени и один для значения.

addParamValue(p,paramName,defaultVal,validationFcn) задает функцию валидации для входного параметра.

Примеры

свернуть все

Подтвердите это значение, соответствующее myParam, со значением по умолчанию 1, числовой скаляр, больше, чем нуль.

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

p = inputParser;
paramName = 'myParam';
defaultVal = 1;
errorMsg = 'Value must be positive, scalar, and numeric.'; 
validationFcn = @(x) assert(isnumeric(x) && isscalar(x) ...
    && (x > 0),errorMsg);
addParamValue(p,paramName,defaultVal,validationFcn)

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

parse(p,'myparam',-1)
The value of 'myparam' is invalid. Value must be positive, scalar, and numeric.

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

свернуть все

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

Имя входного параметра в виде вектора символов или строкового скаляра.

Пример: "firstName"

Пример: 'address'

Типы данных: char | string

Значение по умолчанию для входа в виде любого типа данных. Если argName не вход к функции, когда parse функционируйте анализирует входные параметры, затем это присваивает argName значение defaultVal.

Функция, чтобы подтвердить аргумент в виде указателя на функцию.

Указатель на функцию должен быть сопоставлен с функцией, которая возвращает true или false, или проходит тест или выдает ошибку. Оба типа функций должны принять один входной параметр.

Пример: @(s)isstring(s)

Пример: @(x)isnumeric(x)&&isscalar(x)

Пример: @(n)validateattributes(n,{'numeric'},{'nonnegative'})

Типы данных: function_handle

Советы

  • Пары "имя-значение" параметра являются дополнительными входными параметрами. При вызывании функции пары "имя-значение" могут появиться в любом порядке после позиционных параметров. Они принимают общую форму Name1,Value1,...,NameN,ValueN.

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

|

Темы

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

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