MATLAB: How to use InputParser with multiple argument names

inputparser

I would like to use InputParser with multiple possible argument syntax for the same argument. For instance, to have shorter versions, e.g. that I can do:

do_something('factor',2)

and

do_something('f',2)

with the same result. I tried to use InputParser with cell arrays or char arrays but that does not work. Does someone know how to do this?

Best Answer

Set the PartialMatching property of your inputParser instance to true.

Related Solutions

MATLAB: Check if a number of varibles in a function satifies a condition.

There are already tools for performing these tasks. Check out the InputParser class [ ref, ref ]. It will allow you to declare three sets of arguments: required, optional, and param/value pairs. For each parameter, you will be able to define a check function, as well as a default value for all but required parameters.

EDIT: just as an example, here is the beginning of a function using an input parser

 function [hFig, hAxis, hLegend, hPatches] = bar_varWidth( colWidth, ...
    data, varargin )
    % --- 1. Parse input parameters.
    parser = inputParser ;
    parser.StructExpand  = true ;
    parser.CaseSensitive = false ;
    parser.addRequired( 'colWidth', @isnumeric ) ;
    parser.addRequired( 'data', @isnumeric ) ;
    parser.addParamValue( 'legend', [], @(x) ischar(x) || iscell(x)  ) ;
    parser.addParamValue( 'xTickLabel', [], @(x) isnumeric(x) || iscell(x)  ) ;
    parser.addParamValue( 'xTickLabelFormat', '%.2f', @ischar ) ;
    parser.addParamValue( 'xTickLabelShiftThreshold', 10, @isnumeric ) ;
    parser.addParamValue( 'xTickLabelAngle', 90, @isnumeric ) ;
    parser.addParamValue( 'xTickLabelLineLength', [], @isnumeric ) ;
    parser.parse( colWidth, data, varargin{:} ) ;
    args = parser.Results ;
    % --- 2. ...

and here all parameters are accessible as fields of args, e.g.

    args.colWidth
    args.legend

MATLAB: Does inputParser crash Matlab ~R2013

MathWorks added a new option to inputParser called PartialMatching. This defaults to true although it changes the behavior of inputParser. Unfortunately when used in conjunction with KeepUnmatched it can also cause Matlab to segfault!

Until this is fixed, you can work around with:

ip = inputParser();
if isprop(ip, 'PartialMatching'), ip.PartialMatching = false; end

I've asked MathWorks to make a bug report so we'll know when this is fixed; will post it here if I hear back.

Best Answer

Related Solutions

MATLAB: Check if a number of varibles in a function satifies a condition.

MATLAB: Does inputParser crash Matlab ~R2013

Related Question