parse_pv_pairs

Parsing property/value pairs for function input.

Al momento, stai seguendo questo contributo

An interface that uses property/value pairs is a
good way to provide sets of parameters which have
defaults, but where there may be many possible
parameter options. The user does not want to
remember the sequence of possibly dozens of
arguments, many of which may remain at their
default values.

First, set default values for the parameters.
Assume we have four parameters that we wish to
use optionally in the function examplefun.

- 'viscosity', which will have a default value of 1
- 'volume', which will default to 1
- 'pie' - which will have default value
3.141592653589793
- 'description' - a text field, left empty by default

The first argument to examplefun is one which will always be supplied in this example.

function examplefun(dummyarg1,varargin)
params.Viscosity = 1;
params.Volume = 1;
params.Pie = 3.141592653589793
params.Description = '';
params=parse_pv_pairs(params,varargin);
params

Use examplefun, overriding the defaults for 'pie',
'viscosity' and 'description'. The 'volume' parameter
is left at its default value.

examplefun(rand(10),'pie',3,'vis',10, ...
'Description','Hello world')

params =
Viscosity: 10
Volume: 1
Pie: 3
Description: 'Hello world'

Note that capitalization was ignored, and the
property 'viscosity' was truncated to 'vis' as
supplied. Also note that the order the pairs were
supplied was arbitrary.

Warning: parse_pv_pairs does not check for data
type in any value, nor for validity of the value
should there be any constraints. These are features
I'd like to add in the future.

Cita come

John D'Errico (2026). parse_pv_pairs (https://it.mathworks.com/matlabcentral/fileexchange/9082-parse_pv_pairs), MATLAB Central File Exchange. Recuperato .

Categorie

Scopri di più su Argument Definitions in Help Center e MATLAB Answers

Add the first tag.

Informazioni generali

Compatibilità della release di MATLAB

  • Compatibile con qualsiasi release

Compatibilità della piattaforma

  • Windows
  • macOS
  • Linux
Versione Pubblicato Note della release Action
1.0.0.0

Mlint suggested some changes.