Patrick's Blog

Handling default options in Matlab

September 29th, 2011

I have found the following script useful for dealing with options in Matlab scripts.

function myfunction(input, options)

options_default = defaultOptions();
if (nargin >= 2)
    options = processOptions(options, options_default);
else
    options = options_default;
end

% here comes the logic of myfunction which might access some of the options

end

function options = defaultOptions()

options = [];
options.max_iter = 200;
options.lambda = 1.0;

end % defaultOptions

            view raw
            myfunction.m
            This Gist brought to you by GitHub.

function options = processOptions(optionsInput, optionsDefault)

options = optionsDefault;
if (isstruct(optionsInput))
    fields = fieldnames(optionsInput);
    for i=1:length(fields)
        if (~isstruct(getfield(optionsInput, fields{i})))
            options = setfield(options, fields{i}, getfield(optionsInput, fields{i}));
        else
            temp = processOptions(getfield(optionsInput, fields{i}), ...
                            getfield(options, fields{i}) );
            options = setfield(options, fields{i}, temp);
        end
    end
end

end % processOptions


            view raw
            processOptions.m
            This Gist brought to you by GitHub.
          

Posted in programming | No Comments »