addParameter

Adiciona um argumento nome-valor a um inputParser.

Categoria: Programming > Functions

Sintaxe

addParameter(p, name, default)

Declara um argumento nome-valor com um padrão.

addParameter(p, name, default, validationFcn)

Também valida o valor.

Descrição

Os pares nome-valor podem aparecer em qualquer ordem depois dos argumentos posicionais. Os nomes são comparados sem diferenciar maiúsculas (a menos que CaseSensitive esteja ativo) e uma abreviação única é aceita enquanto PartialMatching estiver ligado. Um nome nunca declarado é erro, a menos que KeepUnmatched seja verdadeiro, caso em que fica em p.Unmatched.

Argumentos de entrada

p
Um objeto inputParser.
name
Nome do parâmetro, como texto. Quem chama o escreve seguido do valor.
default
Valor usado quando o parâmetro não é fornecido.
validationFcn
Handle de uma função que retorna true para um valor válido, ou gera erro.

Exemplo

Parâmetros com padrão

p = inputParser;
addParameter(p, 'Tol', 1e-3, @(v) v > 0);
addParameter(p, 'Verbose', false);
parse(p, 'Tol', 0.5);
p.Results
Saída
ans = struct with fields:

        Tol: 0.5000
    Verbose: 0

Veja também

inputParser addRequired addOptional addParamValue