combineOpt
options = combineOpt (user_options, default_options)
The function allows easy definition and submission of options to a Matlab function.
combineOpt combines the fields of the structure user_options with the fields of the default_options's structure, during which the fields of user_options overwrite the fields of default_options.
Example:
>> user_options.B = 5;
>> user_options.C = 'foo';
>> default_options.A = 1;
>> default_options.B = 0;
>> options = combineOpt (user_options, default_options)
options =
A: 1
B: 5
C: 'foo'
The function can be very useful when there are many optional arguments that can be passed to a function. A useful structuring of one's function is
function y = myfunct(x, opt)
def_options = struct('a',5,'b',0);
if nargin == 0 % return the default options
y = def_options;
return
else
opt = combineOpt (opt, def_options)
end
% further code
end % function
Cite As
Andrey Popov (2024). combineOpt (https://www.mathworks.com/matlabcentral/fileexchange/21424-combineopt), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxCategories
Tags
Acknowledgements
Inspired: fireFly
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.