{"id":2548,"date":"2010-04-02T12:57:41","date_gmt":"2010-04-02T12:57:41","guid":{"rendered":"https:\/\/blogs.mathworks.com\/pick\/2010\/04\/02\/setting-default-values\/"},"modified":"2010-04-02T12:57:41","modified_gmt":"2010-04-02T12:57:41","slug":"setting-default-values","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/pick\/2010\/04\/02\/setting-default-values\/","title":{"rendered":"Setting Default Values"},"content":{"rendered":"
\r\n <\/introduction>\r\n

Brett<\/a>'s Pick this week is SetDefaultValue<\/a>, by Richie Cotton<\/a>.\r\n <\/p>\r\n

Richie wrote in the File Exchange introduction to his SetDefaultValue submission that \"it's so simple that I nearly didn't\r\n upload this, but it does make your functions cleaner.\" In fact, it is<\/i> extremely simple, but it is also widely useful. Anyone who has ever written a program, function, or algorithm--in MATLAB\r\n or in any other language--has likely had to deal with variable initializations umpteen times. Many of us have come up with\r\n clever ways of simplifying the process or, as Richie might say, \"prettifying\" the code.\r\n <\/p>\r\n

SetDefaultValue<\/tt> cleverly uses simple evalin<\/tt><\/a> and assignin<\/tt><\/a> calls to streamline and prettify the process.\r\n <\/p>\r\n

For instance, to conditionally set x<\/tt> to 1 and y<\/tt> to 3 as defaults, one might write:\r\n <\/p>

if<\/span> nargin < 1 || isempty(x)\r\n   x = 1;\r\nend<\/span>\r\n\r\nif<\/span> nargin < 2 || isempty(y)\r\n   y = 3;\r\nend<\/span><\/pre>
\r\n<\/pre>
Richie's submission introduction referred to Loren's blog about setting defaults<\/a>. Loren described the use of a switch\/case<\/tt><\/a> approach, switching based on the number of input arguments.<\/a> That is a perfectly reasonable approach, and one that I've used many times.\r\n   <\/p>\r\n   
My personal style usually has me writing something along these lines:<\/p>
% FUNCTION SYNTAX: foo(reqdArg1,reqdArg2,varargin)<\/span>\r\n\r\n% Defaults<\/span>\r\nx = 1;y = 2;\r\nif<\/span> nargin > 2, x = varargin{1};end<\/span>\r\nif<\/span> nargin > 3, y = varargin{2};end<\/span><\/pre>
With Richie's function, one could replace those lines with these:<\/p>
SetDefaultValue(1, 'x'<\/span>, 1);\r\nSetDefaultValue(2, 'y'<\/span>, 3);<\/pre>
Sometimes, the simplest functions are the most useful ones!<\/p>\r\n   
Anyone else have any clever ways to share for dealing with default values? Share them, or your thoughts on the approaches\r\n      mentioned here, using the comments<\/a> box below.\r\n   <\/p>