How to deal with name/value pairs of function arguments in MATLAB

by

I prefer using structures for my options. This gives you an easy way to store the options and an easy way to define them. Also, the whole thing becomes rather compact.

function example(varargin)

%# define defaults at the beginning of the code so that you do not need to
%# scroll way down in case you want to change something or if the help is
%# incomplete
options = struct('firstparameter',1,'secondparameter',magic(3));

%# read the acceptable names
optionNames = fieldnames(options);

%# count arguments
nArgs = length(varargin);
if round(nArgs/2)~=nArgs/2
   error('EXAMPLE needs propertyName/propertyValue pairs')
end

for pair = reshape(varargin,2,[]) %# pair is {propName;propValue}
   inpName = lower(pair{1}); %# make case insensitive

   if any(strcmp(inpName,optionNames))
      %# overwrite options. If you want you can test for the right class here
      %# Also, if you find out that there is an option you keep getting wrong,
      %# you can use "if strcmp(inpName,'problemOption'),testMore,end"-statements
      options.(inpName) = pair{2};
   else
      error('%s is not a recognized parameter name',inpName)
   end
end

More Related Contents:

  1. “Parameter” vs “Argument” [duplicate]
  2. How to correct “Function definitions are not permitted at the prompt or in scripts”
  3. How can I generate a list of function dependencies in MATLAB?
  4. MATLAB error: Undefined function or method X for input arguments of type ‘double’ [duplicate]
  5. Matlab ode45. How to change a parameter inside it while calling it?
  6. How to receive and maintain values in functions (javascript)
  7. Set a default parameter value for a JavaScript function
  8. What is the difference between a ‘closure’ and a ‘lambda’?
  9. How to explain callbacks in plain english? How are they different from calling one function from another function?
  10. Define table and column names as arguments in a plpgsql function?
  11. How to elegantly ignore some return values of a MATLAB function
  12. Is it possible to get all arguments of a function as single object inside that function?
  13. Why can’t we pass arrays to function by value?
  14. Computing the cross product of two vectors in Fortran 90
  15. Best way to check function arguments? [closed]
  16. How do I define a function with optional arguments?
  17. What happens if I call a JS method with more parameters than it is defined to accept?
  18. Return a list from the function using OUT parameter
  19. How to have multiple conditions for one if statement in python [duplicate]
  20. Define a recursive function within a function in Go
  21. When is a function too long? [closed]
  22. Multiple arguments vs. options object
  23. Two ways of defining functions in Scala. What is the difference?
  24. Get a list/tuple/dict of the arguments passed to a function?
  25. Kotlin: How can I create a “static” inheritable function?
  26. use onedit() trigger on a specific sheet within google scripts for google sheets
  27. Unspecified number of parameters in C functions – void foo()
  28. MsgBox “” vs MsgBox() in VBScript
  29. Proper use of modules in Fortran
  30. Passing a function with arguments as an argument?

Leave a Comment