SETARGS | Parse user-specified optional arguments (varargin) with default values

版本 2.0.0.0 (1.8 KB) 作者: Bob Spunt
Assigning values (default vs. user) to optional arguments (varargin) in a function
348.0 次下载
更新时间 2016/10/31

This is a utility for setting the value of optional arguments to a function. The first argument is required and should be a cell array of "name, default value" pairs for all optional arguments. The second argument is optional and should be a cell array of "name, custom value"pairs for at least one of the optional arguments.
USAGE: argstruct = setargs(defaultargs, varargs)

---
OUTPUT

ARGSTRUCT
structure containing the final argument values

---
INPUTS

DEFAULTARGS
cell array of "'Name', value" pairs for all variables with default values

VARARGS [optional]
cell array of user-specified "'Name', value" pairs for one or more of the variables with default values. this will typically be the "varargin" cell array. for each pair, SETARGS determines if the specified variable name can be uniquely matched to one of the default variable names specified in DEFAULTARGS. matching uses STRNCMPI and thus is case-insensitive and open to partial name matches (e.g., default variable name 'FontWeight' would be matched by 'fontweight', 'Fontw', etc.). if a match is found, the user-specified value is then used in place of the default value. if no match is found or if multiple matches are found, SETARGS returns an error and displays in the command window information about the argument that caused the problem.

---
USAGE EXAMPLE (TO BE USED AT TOP OF FUNCTION WITH VARARGIN)

defaultargs = {'arg1', 0, 'arg2', 'words', 'arg3', rand};
argstruct = setargs(defaultargs, varargin)

引用格式

Bob Spunt (2024). SETARGS | Parse user-specified optional arguments (varargin) with default values (https://github.com/spunt/setargs), GitHub. 检索来源 .

MATLAB 版本兼容性
创建方式 R2014b
兼容任何版本
平台兼容性
Windows macOS Linux
类别
Help CenterMATLAB Answers 中查找有关 Argument Definitions 的更多信息

Community Treasure Hunt

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

Start Hunting!

无法下载基于 GitHub 默认分支的版本

版本 已发布 发行说明
2.0.0.0

Updated documentation and variable names and clarified content of error messages

1.0.0.0

要查看或报告此来自 GitHub 的附加功能中的问题,请访问其 GitHub 仓库
要查看或报告此来自 GitHub 的附加功能中的问题,请访问其 GitHub 仓库