`addOptional`

Adiciona um argumento posicional opcional a um inputParser.

Sintaxe

addOptional(p, name, default)

Declara um argumento opcional com valor padrão.

addOptional(p, name, default, validationFcn)

Também valida o valor.

Descrição

Os argumentos opcionais vêm depois dos obrigatórios e são associados por posição. Quando a chamada traz um valor naquela posição, parse o confere com a função de validação. Um texto que coincide com o nome de um parâmetro declarado não é tomado como o argumento opcional: ele inicia os pares nome-valor e o opcional fica com o padrão.

Os opcionais omitidos aparecem em p.UsingDefaults.

Argumentos de entrada

p: Um objeto inputParser.
name: Nome do argumento, como texto.
default: Valor usado quando o argumento é omitido.
validationFcn: Handle de uma função que retorna true para um valor válido, ou gera erro.

Exemplo

Valor padrão e valor fornecido

p = inputParser;
addRequired(p, 'x');
addOptional(p, 'mode', 'fast', @ischar);
parse(p, 1);
p.Results.mode
parse(p, 1, 'slow');
p.Results.mode
p.UsingDefaults

Saída

ans = 'fast'
ans = 'slow'
ans =

  0×0 empty cell array

Veja também

inputParser addRequired addParameter validatestring