View source for Opt disp

{{Function
|name=opt_disp
|desc=Display a message to the user (sometimes)
|cat=[[List of functions#Helper_functions|Helper functions]]
|upd=December 3, 2012
|v=0.50
|helper=1}}
<tt>'''opt_disp'''</tt> is a [[List of functions|function]] that displays a given message to the user if and only if a specific flag is specified. The only purpose of this function is to reduce the number of <tt>if</tt> statements within the code of other functions, thus making them a bit more readable.

==Syntax==
* <tt>opt_disp(X,VERBOSE)</tt>

==Argument descriptions==
* <tt>X</tt>: A string to be displayed to the user.
* <tt>VERBOSE</tt>: A flag (either 1 or 0) indicating whether or not <tt>X</tt> will be displayed.

==Examples==
Display and don't display a message to the user:
<syntaxhighlight>
>> opt_disp('Hello\n',1)
Hello
>> opt_disp('Hello\n',0)
>>
</syntaxhighlight>

==Notes==
This function is only meant to simplify code within other functions. If you always want to display the message, just use MATLAB's built-in [http://www.mathworks.com/help/matlab/ref/disp.html disp] or [http://www.mathworks.com/help/matlab/ref/fprintf.html fprintf] function. Note that <tt>opt_disp</tt> uses <tt>fprintf</tt>, so you may need to end your string with a newline character <tt>\n</tt> (as in the example) for it to function how you expect.

{{SourceCode|name=opt_disp|helper=1}}