Template:Function - Revision history

Nathaniel at 19:16, 13 April 2015

2015-04-13T19:16:01Z

← Older revision		Revision as of 19:16, 13 April 2015
Line 1:		Line 1:
	<table class="infobox">		<table class="infobox"><tr><td colspan="2" class="infobox_head"> {{{name\|Function Name}}}<includeonly>[[Category:Functions]]</includeonly> </td></tr>{{#if: {{{desc\|}}} \| <tr><td colspan="2" align="center">{{{desc\|}}}</td></tr> \| }}<tr><td colspan="2"><hr></td></tr>
	<tr><td colspan="2" class="infobox_head"> {{{name\|Function Name}}} </td></tr>
	{{#if: {{{desc\|}}} \| <tr><td colspan="2" align="center">{{{desc\|}}}</td></tr> \| }}<tr><td colspan="2"><hr></td></tr>
	<tr>		<tr>
	<th valign="top"> Other toolboxes required </th>		<th valign="top"> Other toolboxes required </th>
	<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>		<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}<noinclude>This is an infobox template to be placed on '''[[List of functions\|function]]''' pages. An example of this infobox can be seen to the right.
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
	{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}
	<noinclude>
	This is an infobox template to be placed on '''[[List of functions\|function]]''' pages. An example of this infobox can be seen to the right.

	==Parameters==		==Parameters==
Line 23:		Line 15:
	*'''upd''' (optional): The date when the MATLAB script was last updated.		*'''upd''' (optional): The date when the MATLAB script was last updated.
	</noinclude>		</noinclude>
	~~<includeonly>~~
	~~[[Category:Functions]]~~
	~~</includeonly>~~

Nathaniel at 18:42, 13 April 2015

2015-04-13T18:42:52Z

← Older revision		Revision as of 18:42, 13 April 2015
Line 8:		Line 8:
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
	{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}		{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}
	~~<tr>~~
	~~<th> Last updated </th>~~
	~~<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>~~
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}		{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}

Nathaniel: Removed QETLAB link

2014-12-17T21:20:44Z

Removed QETLAB link

← Older revision		Revision as of 21:20, 17 December 2014
Line 12:		Line 12:
	<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>		<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}		{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}
	<noinclude>		<noinclude>
	This is an infobox template to be placed on '''[[List of functions\|function]]''' pages. An example of this infobox can be seen to the right.		This is an infobox template to be placed on '''[[List of functions\|function]]''' pages. An example of this infobox can be seen to the right.
Line 19:		Line 19:
	*'''name''': The name of the function (all one word, including the .m suffix)		*'''name''': The name of the function (all one word, including the .m suffix)
	*'''desc''' (optional): A one-line description of the function (should be the same as the brief description given in the MATLAB header file)		*'''desc''' (optional): A one-line description of the function (should be the same as the brief description given in the MATLAB header file)
	*'''lic''' (optional): Set equal to 1 (and upload a license file!) if this function was written by someone not directly affiliated with [[QETLAB]] (e.g., if you got the function from [http://www.mathworks.com/matlabcentral/fileexchange/ MATLAB File Exchange]). Ignore this parameter otherwise.		*'''lic''' (optional): Set equal to 1 (and upload a license file!) if this function was written by someone not directly affiliated with QETLAB (e.g., if you got the function from [http://www.mathworks.com/matlabcentral/fileexchange/ MATLAB File Exchange]). Ignore this parameter otherwise.
	*'''req''' (optional): A list of other MATLAB toolboxes that are required for this script to work (such as [http://cvxr.com/cvx/ cvx]). Please separate different toolboxes by a <br /> tag. Also, make each toolbox name a link whenever possible.		*'''req''' (optional): A list of other MATLAB toolboxes that are required for this script to work (such as [http://cvxr.com/cvx/ cvx]). Please separate different toolboxes by a <br /> tag. Also, make each toolbox name a link whenever possible.
	*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.		*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.

Nathaniel at 18:21, 16 December 2014

2014-12-16T18:21:36Z

← Older revision		Revision as of 18:21, 16 December 2014
Line 7:		Line 7:
	{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}		{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
	{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td~~> <tt~~>{{{cvx}}}~~</tt>~~ </td></tr> }}		{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}
	<tr>		<tr>
	<th> Last updated </th>		<th> Last updated </th>

Nathaniel: Added CVX parameter

2014-12-16T18:21:13Z

Added CVX parameter

← Older revision		Revision as of 18:21, 16 December 2014
Line 7:		Line 7:
	{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}		{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
			{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> <tt>{{{cvx}}}</tt> </td></tr> }}
	<tr>		<tr>
	<th> Last updated </th>		<th> Last updated </th>
Line 22:		Line 23:
	*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.		*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.
	*'''cat''' (optional): The category that this function belongs to.		*'''cat''' (optional): The category that this function belongs to.
			*'''cvx''' (optional): Whether or not this function can be used (as a constraint or objective function) within CVX optimization problems. Suggested values are "no", "yes (linear)", "yes (convex)", and "yes (concave)".
	*'''upd''' (optional): The date when the MATLAB script was last updated.		*'''upd''' (optional): The date when the MATLAB script was last updated.
	</noinclude>		</noinclude>

Nathaniel: Removed the "version" field: end-users don't need to see that.

2014-11-12T17:27:47Z

Removed the "version" field: end-users don't need to see that.

← Older revision		Revision as of 17:27, 12 November 2014
Line 10:		Line 10:
	<th> Last updated </th>		<th> Last updated </th>
	<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>		<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>
	~~<tr>~~
	~~<th> Version </th>~~
	~~<td> {{#if: {{{v\|}}} \| {{{v}}} \| ?? }} </td></tr>~~
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}		{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}
Line 26:		Line 23:
	*'''cat''' (optional): The category that this function belongs to.		*'''cat''' (optional): The category that this function belongs to.
	*'''upd''' (optional): The date when the MATLAB script was last updated.		*'''upd''' (optional): The date when the MATLAB script was last updated.
	*'''v''' (optional): The version number of the script. For consistency across QETLAB, the script number should be of the form X.yz (e.g., 1.00)
	</noinclude>		</noinclude>
	<includeonly>		<includeonly>
	[[Category:Functions]]		[[Category:Functions]]
	</includeonly>		</includeonly>

Nathaniel: Moves license files to github

2014-11-07T17:58:23Z

Moves license files to github

← Older revision		Revision as of 17:58, 7 November 2014
Line 13:		Line 13:
	<th> Version </th>		<th> Version </th>
	<td> {{#if: {{{v\|}}} \| {{{v}}} \| ?? }} </td></tr>		<td> {{#if: {{{v\|}}} \| {{{v}}} \| ?? }} </td></tr>
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[~~http~~://~~www~~.~~qetlab~~.com/~~source~~/{{#if: {{{helper\|}}} \| ~~license~~/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}		{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}
	<noinclude>		<noinclude>

Nathaniel at 15:54, 29 September 2014

2014-09-29T15:54:00Z

← Older revision		Revision as of 15:54, 29 September 2014
Line 24:		Line 24:
	*'''req''' (optional): A list of other MATLAB toolboxes that are required for this script to work (such as [http://cvxr.com/cvx/ cvx]). Please separate different toolboxes by a <br /> tag. Also, make each toolbox name a link whenever possible.		*'''req''' (optional): A list of other MATLAB toolboxes that are required for this script to work (such as [http://cvxr.com/cvx/ cvx]). Please separate different toolboxes by a <br /> tag. Also, make each toolbox name a link whenever possible.
	*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.		*'''rel''' (optional): A list of other functions that are similar to this function or closely-related to it in some way. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.
	'''cat''' (optional): The category that this function belongs to.		*'''cat''' (optional): The category that this function belongs to.
	*'''upd''' (optional): The date when the MATLAB script was last updated.		*'''upd''' (optional): The date when the MATLAB script was last updated.
	*'''v''' (optional): The version number of the script. For consistency across QETLAB, the script number should be of the form X.yz (e.g., 1.00)		*'''v''' (optional): The version number of the script. For consistency across QETLAB, the script number should be of the form X.yz (e.g., 1.00)

Nathaniel at 15:03, 22 September 2014

2014-09-22T15:03:02Z

← Older revision		Revision as of 15:03, 22 September 2014
Line 6:		Line 6:
	<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>		<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>
	{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}		{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td~~> <tt~~>{{{cat}}}~~</tt>~~ </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
	<tr>		<tr>
	<th> Last updated </th>		<th> Last updated </th>

Nathaniel at 14:59, 22 September 2014

2014-09-22T14:59:46Z

← Older revision		Revision as of 14:59, 22 September 2014
Line 6:		Line 6:
	<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>		<td> {{#if: {{{req\|}}} \|<tt> {{{req}}}</tt> \| none }} </td></tr>
	{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}		{{#if: {{{rel\|}}} \| <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[~~Functions~~\|Function]] category</th><td> <tt>{{{cat}}}</tt> </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> <tt>{{{cat}}}</tt> </td></tr> }}
	<tr>		<tr>
	<th> Last updated </th>		<th> Last updated </th>

← Older revision		Revision as of 18:42, 13 April 2015
Line 8:		Line 8:
	{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}		{{#if: {{{cat\|}}} \| <tr><th valign="top"> [[List of functions\|Function]] category</th><td> {{{cat}}} </td></tr> }}
	{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}		{{#if: {{{cvx\|}}} \| <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </td></tr> }}
	~~<tr>~~
	~~<th> Last updated </th>~~
	~~<td> {{#if: {{{upd\|}}} \| {{{upd}}} \| ?? }} </td></tr>~~
	{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}		{{#if: {{{lic\|}}} \| <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper\|}}} \| helpers/}}license_{{{name\|FunctionName}}}.txt license_{{{name\|FunctionName}}}.txt]</tt> </td></tr> }}
	</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}		</table>{{#if: {{{helper\|}}} \| <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''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.</td></tr></table>}}