parseargs: Simplifies input processing for functions with multiple options

For parsing function arguments supplied as name-value pairs, e.g. 'XLim',[0 10],'YLim',[0 100]
4,9K téléchargements
Mise à jour 1 sept. 2016

Afficher la licence

Based on same idea as the excellent "parse_pv_pairs", and similar to the "inputParser" object added to MATLAB in R2007a, this function handles names and values for properties in any order, and assigns the values to a structure containing default values.
For example, in your function which has options "StartTime" and
"StopOnError", create a structure of defaults and pass inputs to parseargs:

| function myfunction(varargin)
| X.StartTime = 0;
| X.StopOnError = true;
| X = parseargs(X,varargin{:})

If the user specifies inputs:
| myfunction('StopOnError',false,'StartTime',5)
the structure will be modified accordingly.

The aim of this function is to ease as much as possible the tedious and error prone task of handling inputs, specifically with a view to application development (rather than quick scripting), where robustness is of high importance.

To this end, the function enforces some rules, partly to reduce the chance of mistakes by the caller, and partly to save the user from writing additional code to enforce them:
1) Property names must be specified in full, and are case-sensitive
2) The data type of a property cannot be changed (unless the property was initially empty)
3) Scalar values must remain scalar
4) Where the original value is a cell array it must contain strings. The new value must be one of these strings, and if no new value is specified, the first string is selected as a default.

Citation pour cette source

Malcolm Wood (2024). parseargs: Simplifies input processing for functions with multiple options (, MATLAB Central File Exchange. Récupéré le .

Compatibilité avec les versions de MATLAB
Créé avec R12.1
Compatible avec toutes les versions
Plateformes compatibles
Windows macOS Linux

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Version Publié le Notes de version

Updated license

Added copyright lines and suppressed M-Lint warnings.