Opt disp

From QETLAB
Jump to navigation Jump to search
opt_disp
Display a message to the user (sometimes)

Other toolboxes required none
Function category Helper functions
This is a helper function that only exists to aid other functions in QETLAB. If you are an end-user of QETLAB, you likely will never have a reason to use this function.

opt_disp is a 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 if statements within the code of other functions, thus making them a bit more readable.

Syntax

  • opt_disp(X,VERBOSE)

Argument descriptions

  • X: A string to be displayed to the user.
  • VERBOSE: A flag (either 1 or 0) indicating whether or not X will be displayed.

Examples

Display and don't display a message to the user:

>> opt_disp('Hello\n',1)
Hello
>> opt_disp('Hello\n',0)
>>

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 disp or fprintf function. Note that opt_disp uses fprintf, so you may need to end your string with a newline character \n (as in the example) for it to function how you expect.

Source code

Click here to view this function's source code on github.