Opt args - Revision history

Nathaniel at 16:06, 29 September 2014

2014-09-29T16:06:21Z

← Older revision		Revision as of 16:06, 29 September 2014
Line 2:		Line 2:
	\|name=opt_args		\|name=opt_args
	\|desc=Handles optional input arguments for [[List of functions\|functions]]		\|desc=Handles optional input arguments for [[List of functions\|functions]]
			\|cat=[[List of functions#Helper_functions\|Helper functions]]
	\|upd=November 2, 2012		\|upd=November 2, 2012
	\|v=1.00		\|v=0.50
	\|helper=1}}		\|helper=1}}
	<tt>'''opt_args'''</tt> is a [[List of functions\|function]] that provides a simple way of handling optional arguments within other functions. It reads in a cell of default values of variables and replaces them by optional argument values if those values were provided by the end-user. This reduces a check for optional arguments from what is often 8 or 9 lines of code down to 1 line of code, and also makes code easier to read. End-users of QETLAB have no reason to use this function.		<tt>'''opt_args'''</tt> is a [[List of functions\|function]] that provides a simple way of handling optional arguments within other functions. It reads in a cell of default values of variables and replaces them by optional argument values if those values were provided by the end-user. This reduces a check for optional arguments from what is often 8 or 9 lines of code down to 1 line of code, and also makes code easier to read. End-users of QETLAB have no reason to use this function.
Line 16:		Line 17:
	==Examples==		==Examples==
	Please see the source code of functions such as <tt>[[PermuteSystems]]</tt> to see examples of this function in use.		Please see the source code of functions such as <tt>[[PermuteSystems]]</tt> to see examples of this function in use.

			{{SourceCode\|name=opt_args\|helper=1}}

Nathaniel: /* Examples */

2012-11-15T20:05:10Z

Examples

← Older revision		Revision as of 20:05, 15 November 2012
Line 15:		Line 15:

	==Examples==		==Examples==
	Please see the source code of functions such as [[PermuteSystems]] to see examples of this function in use.		Please see the source code of functions such as <tt>[[PermuteSystems]]</tt> to see examples of this function in use.

Nathaniel: Created page with "{{Function |name=opt_args |desc=Handles optional input arguments for functions |upd=November 2, 2012 |v=1.00 |helper=1}} `'''opt_args'''` is a [[L..."

2012-11-15T20:04:25Z

Created page with "{{Function |name=opt_args |desc=Handles optional input arguments for functions |upd=November 2, 2012 |v=1.00 |helper=1}} <tt>'''opt_args'''</tt> is a [[L..."

New page

{{Function
|name=opt_args
|desc=Handles optional input arguments for [[List of functions|functions]]
|upd=November 2, 2012
|v=1.00
|helper=1}}
<tt>'''opt_args'''</tt> is a [[List of functions|function]] that provides a simple way of handling optional arguments within other functions. It reads in a cell of default values of variables and replaces them by optional argument values if those values were provided by the end-user. This reduces a check for optional arguments from what is often 8 or 9 lines of code down to 1 line of code, and also makes code easier to read. End-users of QETLAB have no reason to use this function.

==Syntax==
* <tt>VARARGOUT = opt_args(DEF_ARGS,EXTRA_ARG1,EXTRA_ARG2,...)</tt>

==Argument descriptions==
* <tt>DEF_ARGS</tt>: A cell containing default argument values. These same values will be output by <tt>opt_args</tt> unless they are overwritten by one of the optional arguments.
* <tt>EXTRA_ARGn</tt> (optional): If provided, the n-th optional argument to this function will be its n-th output argument (in place of <tt>DEF_ARGS{n}</tt>).

==Examples==
Please see the source code of functions such as [[PermuteSystems]] to see examples of this function in use.

Opt args - Revision history

Nathaniel at 16:06, 29 September 2014

Nathaniel: /* Examples */

Nathaniel: Created page with "{{Function |name=opt_args |desc=Handles optional input arguments for functions |upd=November 2, 2012 |v=1.00 |helper=1}} '''opt_args''' is a [[L..."

Nathaniel: Created page with "{{Function |name=opt_args |desc=Handles optional input arguments for functions |upd=November 2, 2012 |v=1.00 |helper=1}} `'''opt_args'''` is a [[L..."