File Exchange

image thumbnail

combineOpt

version 1.3 (2.06 KB) by

Combine user provided option's structure with a default one

0 Downloads

Updated

View License

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

Comments and Ratings (1)

Jos x@y.z

Updates

1.3

Fixed typo

1.2

Updated author information

1.1

Updated license in the M file

MATLAB Release
MATLAB 7.2 (R2006a)
Acknowledgements

Inspired: fireFly

Download apps, toolboxes, and other File Exchange content using Add-On Explorer in MATLAB.

» Watch video