parse

Método de inputParser que confere os argumentos de uma chamada com os parâmetros declarados.

Categoria: Programming > Functions

Sintaxe

parse(p, varargin)

Descrição

parse atribui os valores informados aos nomes declarados, verifica cada um com sua função de validação e preenche os padrões do que não foi dado. Depois da chamada, p.Results é um struct com um campo por argumento declarado, p.UsingDefaults lista os nomes que usaram o padrão e p.Unmatched guarda pares nome-valor não declarados quando KeepUnmatched é verdadeiro.

Se um argumento obrigatório faltar, a chamada falha com Not enough input arguments. Se um validador rejeitar um valor, a mensagem indica o argumento e a função que falhou.

Argumentos de entrada

p

Um objeto inputParser no qual addRequired, addOptional, addParameter ou addParamValue já foram chamados.

varargin

Os valores a analisar: primeiro os obrigatórios, depois os opcionais, depois os pares nome-valor.

Exemplo

Argumentos obrigatórios, opcionais e nome-valor

p = inputParser;
addRequired(p, 'x');
addOptional(p, 'n', 5);
addParameter(p, 'mode', 'fast');
parse(p, 10, 'mode', 'slow');
r = p.Results
p.UsingDefaults

r = struct with fields:

    mode: 'slow'
       n: 5
       x: 10
ans = 1×1 cell

    {'n'}

Veja também

inputParser validateattributes narginchk validatestring