Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nvictus/argutils
Argument parsing utilities for MATLAB
https://github.com/nvictus/argutils
Last synced: 24 days ago
JSON representation
Argument parsing utilities for MATLAB
- Host: GitHub
- URL: https://github.com/nvictus/argutils
- Owner: nvictus
- License: bsd-2-clause
- Created: 2013-06-12T06:48:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-06-30T18:07:19.000Z (over 11 years ago)
- Last Synced: 2024-10-03T12:17:51.528Z (3 months ago)
- Language: Matlab
- Size: 313 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
ArgUtils
========
Argument parsing utilities for MATLAB
[Get it on the File Exchange](http://www.mathworks.com/matlabcentral/fileexchange/42205)
Particularly useful for assigning defaults to functions that use varargin or structs of input parameters
- Use `ArgUtils.assignVars()` to assign variables _sequentially_
- Use `ArgUtils.assignArgs()` to assign _named_ variables. This accepts either struct input or cell-array input containing a sequence of values followed by keyword-matching name-value pairs in any order. Keywords are matched using MATLAB's string validator, so matching is case-insensitive and abbreviated keywords are acceptable as long as they can be matched unambiguously.
There are also options to specify:
- required input parameters
- string prefixes on keywords to prevent name collisions with string values
Examples
--------
Parse your `varargin`, like a boss!
```matlab
function example(varargin)
import ArgUtils.*
% default values for input arguments
defaults.x = [];
defaults.y = 2;
defaults.z = 3;
defaults.state = 'off';
defaults.tol = 0.001;
[x,y,z,state,tol] = assignArgs( defaults, varargin, 'Expand', true, 'Required', {'x'} )
...
```
```matlab
>> example(100, 200, 'tol', 0.999, 'z', 'zulu') %args followed by kwargs, python-style!
x =
100
y =
200
z =
zulu
state =
off
tol =
0.9990
>> example('y',200, 'z',300) %oops! we said x is a required arg...
Error using example:
Required argument x is missing.
>> example('x',100, 'y',200, 300) %that's a no-no!
Error using example:
Keyword arguments must be given as name-value pairs.
```
--
Parse an options struct, and get additional toppings...free!
```matlab
function example2(name, num_scoops, options)
default.cone_size = 'large';
default.flavor = 'vanilla';
default.sprinkles = true;
default.whipped_cream = true;
default.syrup = true;
default.cherry_on_top = true;
options = ArgUtils.assignArgs( default, options )
...
```
```matlab
>> opts.flav = 'chocolate';
>> example2('nezar', 3, opts)
options =
cone_size: 'large'
flavor: 'chocolate'
sprinkles: 1
whipped_cream: 1
syrup: 1
cherry_on_top: 1
```
--
Worried about string inputs clashing with argument names? Set a prefix for name keywords.
As a bonus, your function now accepts "switches" in command mode! You hacker, you...
```matlab
function example3(varargin)
default.url = 'www.imgur.com';
default.query = 'cats';
[url, query] = ArgUtils.assignArgs( default, varargin, 'Expand', true, 'Prefix', '-' );
...
```
```matlab
>> example3 -url www.github.com -query ArgUtils
```
```matlab
>> example3 -q url -u example.com
```
--
For simple sequential assignment, you can parse `varargin` with `assignVars()`. It emulates the common "~exist or isempty" idiom to assign defaults.
```matlab
function example4(varargin)
[a,b,c] = ArgUtils.assignVars({1, 2, 3}, varargin)
...
```
```matlab
>> example4('alpha', 'bravo')
a =
alpha
b =
bravo
c =
3
>> example4('alpha', [], 'charlie')
a =
alpha
b =
2
c =
charlie
```