FUNCTION - Revision history

Jrheinlaender at 19:53, 27 June 2018

2018-06-27T19:53:07Z

← Older revision		Revision as of 19:53, 27 June 2018
Line 1:		Line 1:
	{{Keyword		{{Keyword
	\|		\|1=
	<code>FUNCTION { hints, [[symbol]], [[symbol]]\|[[symbol list]] }</code>		<code>FUNCTION { { hints }, [[symbol]], [[symbol]]\|[[symbol list]] }</code>
	\|
	Declare a user-defined function. ~~The~~ second parameter is the name of the function~~. The~~ the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.		<code>FUNCTION { { hints }, [[string]], [[symbol]], [[symbol]]\|[[symbol list]] }</code>
			\|2=
			Declare a user-defined function. In the first form, the second parameter is the name of the function and the the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.
			In the second form, the second parameter is an optional print name for the function. This makes it possible to define multiple functions that print with the same name. This is mostly useful if you want a function that takes a [[quantity\|quantities]] as its argument.

	The way that iMath treats this function can be influenced by function hints:		The way that iMath treats this function can be influenced by function hints:
Line 13:		Line 16:
	* defdiff: Differentiate the definition of the function, not the function itself (e.g. <code>sin(x)</code> will be differentiated to <code>cos(x)</code> and not to <code>(sin(x))'</code>.		* defdiff: Differentiate the definition of the function, not the function itself (e.g. <code>sin(x)</code> will be differentiated to <code>cos(x)</code> and not to <code>(sin(x))'</code>.
	\|		\|
	<code>FUNCTION {none, f, x}</code> declares the function <code>f</code> with one argument.		3=
	\|		<code>FUNCTION { {none}, f, x}</code> declares the function <code>f</code> with one argument.

			<code>
			FUNCTION { {none}, "cos", rcos, x}

			FUNCDEF rcos(x) = cos(x / %unity)
			</code>

			declares a variant of the cosine function that can handle arguments with the unit <code>%unity</code>. Have a look at the [[FAQ#Using_iMath_questions\|FAQ entry]] "How can I have iMath print the unit <code>%radian</code>?".
			\|4=
	[[FUNCDEF]]		[[FUNCDEF]]
			\|5=
			2.2.0 or earlier (the second form exists since 2.2.4)
	}}		}}
	[[Category:Declaration]]		[[Category:Declaration]]

Jrheinlaender at 19:30, 6 July 2017

2017-07-06T19:30:02Z

← Older revision		Revision as of 19:30, 6 July 2017
Line 7:		Line 7:
	The way that iMath treats this function can be influenced by function hints:		The way that iMath treats this function can be influenced by function hints:
	* none: No function hints. Must be used because iMath requires three arguments to the <code>FUNCTION</code> declaration.		* none: No function hints. Must be used because iMath requires three arguments to the <code>FUNCTION</code> declaration.
	* lib: A [[library function]]. It will not be affected by <code>[[CLEAREQUATIONS]]</code>.		* lib: A library function. It will not be affected by <code>[[CLEAREQUATIONS]]</code>. This is useful for building up a collection of functions that can be used throughout the whole document.
	* trig: For trigonometric functions. Tells iMath that this function will get special treatment when printing (e.g. sin²''x'' instead of (sin''x'')²) .		* trig: For trigonometric functions. Tells iMath that this function will get special treatment when printing (e.g. sin²''x'' instead of (sin''x'')²) .
	* expand: The function is to be expanded immediately. Useful for functions that are abbreviations, e.g. <code>square(x)</code> will be expanded to <code>x^2</code> whenever it is used.		* expand: The function is to be expanded immediately. Useful for functions that are abbreviations, e.g. <code>square(x)</code> will be expanded to <code>x^2</code> whenever it is used.

Jrheinlaender at 15:33, 2 July 2017

2017-07-02T15:33:20Z

← Older revision		Revision as of 15:33, 2 July 2017
Line 1:		Line 1:
	{{Keyword		{{Keyword
	\|		\|
	<code>FUNCTION { hints, [[symbol]], [[symbol]]\|[[~~expression~~ list]] }</code>		<code>FUNCTION { hints, [[symbol]], [[symbol]]\|[[symbol list]] }</code>
	\|		\|
	Declare a user-defined function. The second parameter is the name of the function. The the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.		Declare a user-defined function. The second parameter is the name of the function. The the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.

Jrheinlaender at 15:31, 2 July 2017

2017-07-02T15:31:50Z

← Older revision		Revision as of 15:31, 2 July 2017
Line 1:		Line 1:
	{{Keyword		{{Keyword
	\|		\|
	<code>FUNCTION { hints, [[symbol]], [[symbol]]\|[[~~exlist~~]] }</code>		<code>FUNCTION { hints, [[symbol]], [[symbol]]\|[[expression list]] }</code>
	\|		\|
	Declare a user-defined function. The second parameter is the name of the function. The the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.		Declare a user-defined function. The second parameter is the name of the function. The the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.

Jrheinlaender at 19:12, 27 June 2017

2017-06-27T19:12:47Z

← Older revision		Revision as of 19:12, 27 June 2017
Line 14:		Line 14:
	\|		\|
	<code>FUNCTION {none, f, x}</code> declares the function <code>f</code> with one argument.		<code>FUNCTION {none, f, x}</code> declares the function <code>f</code> with one argument.
			\|
			[[FUNCDEF]]
	}}		}}
	[[Category:Declaration]]		[[Category:Declaration]]

Jrheinlaender at 16:21, 26 March 2017

2017-03-26T16:21:17Z

← Older revision		Revision as of 16:21, 26 March 2017
Line 7:		Line 7:
	The way that iMath treats this function can be influenced by function hints:		The way that iMath treats this function can be influenced by function hints:
	* none: No function hints. Must be used because iMath requires three arguments to the <code>FUNCTION</code> declaration.		* none: No function hints. Must be used because iMath requires three arguments to the <code>FUNCTION</code> declaration.
	* lib: A library function. It will not be affected by <code>[[CLEAREQUATIONS]]</code>.		* lib: A [[library function]]. It will not be affected by <code>[[CLEAREQUATIONS]]</code>.
	* trig: For trigonometric functions. Tells iMath that this function will get special treatment when printing (e.g. sin²''x'' instead of (sin''x'')²) .		* trig: For trigonometric functions. Tells iMath that this function will get special treatment when printing (e.g. sin²''x'' instead of (sin''x'')²) .
	* expand: The function is to be expanded immediately. Useful for functions that are abbreviations, e.g. <code>square(x)</code> will be expanded to <code>x^2</code> whenever it is used.		* expand: The function is to be expanded immediately. Useful for functions that are abbreviations, e.g. <code>square(x)</code> will be expanded to <code>x^2</code> whenever it is used.

Jrheinlaender: Created page with "{{Keyword | `FUNCTION { hints, symbol, symbol|exlist }` | Declare a user-defined function. The second parameter is the name of the function. The th..."

2017-03-25T16:36:44Z

Created page with "{{Keyword | <code>FUNCTION { hints, symbol, symbol|exlist }</code> | Declare a user-defined function. The second parameter is the name of the function. The th..."

New page

{{Keyword
|
<code>FUNCTION { hints, [[symbol]], [[symbol]]|[[exlist]] }</code>
|
Declare a user-defined function. The second parameter is the name of the function. The the third parameter declares the arguments of the function and can be either a single symbol or a list of symbols.

The way that iMath treats this function can be influenced by function hints:
* none: No function hints. Must be used because iMath requires three arguments to the <code>FUNCTION</code> declaration.
* lib: A library function. It will not be affected by <code>[[CLEAREQUATIONS]]</code>.
* trig: For trigonometric functions. Tells iMath that this function will get special treatment when printing (e.g. sin²''x'' instead of (sin''x'')²) .
* expand: The function is to be expanded immediately. Useful for functions that are abbreviations, e.g. <code>square(x)</code> will be expanded to <code>x^2</code> whenever it is used.
* nobracket: The function does not require brackets around the argument (e.g. <code>sqrt(x)</code> is printed as <math>root x</math>).
* defdiff: Differentiate the definition of the function, not the function itself (e.g. <code>sin(x)</code> will be differentiated to <code>cos(x)</code> and not to <code>(sin(x))'</code>.
|
<code>FUNCTION {none, f, x}</code> declares the function <code>f</code> with one argument.
}}
[[Category:Declaration]]