image thumbnail

Process named Arguments

version 1.5.0.0 (1.9 KB) by Alan Robinson
Easily add optional, named arguments to your functions, like this: f('var_name', value).

601 Downloads

Updated 07 Jan 2014

View License

Assigns named arguments passed to your function to local variables (as in plot(), etc.). The name of the argument is the name of the local variable in your function.

Example: inputfun('prompt', '>', 'defval', 5.1, 'timeout', 5);

This is the same idea as Matlab's inputParser, but with a focus on being really simple and easy to use. Other implementations of this idea on File Exchange require a lot of lines of code to set this up, where as my code just requires one extra function call near the top of your function.

Usage:
(1) in your function, define local variables with their default values;
(2) call procArgs(varargin)

Minimal error checking: requires that all passed variable names match already defined variables in your function. It would be pretty easy to add type checking if you wanted it (I don't, particularly).

Example:


function test(varargin)
name = 'John';
age = 32;
procArgs(varargin)
fprintf('name=%s, age=%i\n', name, age);

%% example calls
test('name', 'Amber'); % prints Amber, 32
test('age', 99); % prints John, 99
test('Ages', 0); % error, will report that Ages is not defined.

Cite As

Alan Robinson (2021). Process named Arguments (https://www.mathworks.com/matlabcentral/fileexchange/25881-process-named-arguments), MATLAB Central File Exchange. Retrieved .

MATLAB Release Compatibility
Created with R2007a
Compatible with any release
Platform Compatibility
Windows macOS Linux

Community Treasure Hunt

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

Start Hunting!