Average (Arraylist function) - Revision history

Rob at 19:50, 8 March 2013

2013-03-08T19:50:42Z

← Older revision		Revision as of 19:50, 8 March 2013
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul>		<ul>

			what goes up


	<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the <var>Arraylist</var> item values		<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the <var>Arraylist</var> item values
	before calculating the average. The <var class="term">itemFunction</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values.		before calculating the average. The <var class="term">itemFunction</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values.

JAL2 at 16:40, 27 July 2012

2012-07-27T16:40:13Z

← Older revision		Revision as of 16:40, 27 July 2012
Line 12:		Line 12:
	<td>An <var>Arraylist</var> object.</td></tr>		<td>An <var>Arraylist</var> object.</td></tr>

	<tr><th>~~method~~</th>		<tr><th>itemFunction</th>
	<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.		<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.
	<p>		<p>
	The default <var class="term">~~method~~</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter\|This]]</var>, which simply returns the item value.</p></td></tr>		The default <var class="term">itemFunction</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter\|This]]</var>, which simply returns the item value.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The optional <var class="term">~~method~~</var> parameter lets you further manipulate the <var>Arraylist</var> item values		<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the <var>Arraylist</var> item values
	before calculating the average. The <var class="term">~~method~~</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">~~method~~</var> function that can map the item values to intrinsic values.		before calculating the average. The <var class="term">itemFunction</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values.
	<p>		<p>
	For example, for an <var>Arraylist</var> that is a list of coordinates, you could		For example, for an <var>Arraylist</var> that is a list of coordinates, you could
	return the average of their distance from the origin by first applying a local function as the <var>Average</var> method's <var class="term">~~method~~</var> parameter: </p>		return the average of their distance from the origin by first applying a local function as the <var>Average</var> method's <var class="term">itemFunction</var> parameter: </p>
	<p class="code">b		<p class="code">b
	class point		class point

JAL2: /* Syntax terms */

2012-07-19T15:27:06Z

Syntax terms

← Older revision		Revision as of 15:27, 19 July 2012
Line 15:		Line 15:
	<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.		<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.
	<p>		<p>
	The default <var class="term">method</var> value is the special identity function, <var>This</var>, which simply returns the item value.</p></td></tr>		The default <var class="term">method</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter\|This]]</var>, which simply returns the item value.</p></td></tr>
	</table>		</table>

JAL2: /* Usage notes */

2012-07-19T15:18:43Z

Usage notes

← Older revision		Revision as of 15:18, 19 July 2012
Line 21:		Line 21:
	<ul>		<ul>
	<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values		<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values
	before calculating the average.		before calculating the average. The <var class="term">method</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">method</var> function that can map the item values to intrinsic values.
	The <var class="term">method</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">~~itemFunction~~</var> function that can map the item values to intrinsic values.
	<p>		<p>
	For example, for an <var>Arraylist</var> that is a list of coordinates, you could		For example, for an <var>Arraylist</var> that is a list of coordinates, you could

JAL2: /* Usage notes */

2012-07-19T15:15:14Z

Usage notes

← Older revision		Revision as of 15:15, 19 July 2012
Line 21:		Line 21:
	<ul>		<ul>
	<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values		<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values
	before ~~performing~~ the <var>~~Average~~</var> ~~method's operation.~~		before calculating the average.
	~~If your~~ <var>~~Arraylist~~</var>'s items are not intrinsic values, you must specify a function that can map the item values to intrinsic values ~~or the method will fail~~.		The <var class="term">method</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values.
	<p>		<p>
	For example, for an <var>Arraylist</var> that is a list of coordinates, you could		For example, for an <var>Arraylist</var> that is a list of coordinates, you could

JAL2: /* Examples */

2012-07-16T19:50:57Z

Examples

← Older revision		Revision as of 19:50, 16 July 2012
Line 58:		Line 58:

	==Examples==		==Examples==
	<p class="code">b		This request calculates the average of a three-item <var>Arraylist</var>:<p class="code">b
	%al is arrayList of float		%al is arrayList of float

JAL2: /* Examples */

2012-07-12T21:41:10Z

Examples

← Older revision		Revision as of 21:41, 12 July 2012
Line 62:		Line 62:

	%al = new		%al = new
	%al~~:add~~(5)		%al = [[List (Arraylist function)\|list]](5, 3, 8)
	~~%al:add~~(3)
	~~%al:add(~~8)

	print %al:average		print %al:average

JAL2 at 18:57, 10 July 2012

2012-07-10T18:57:31Z

← Older revision		Revision as of 18:57, 10 July 2012
Line 13:		Line 13:

	<tr><th>method</th>		<tr><th>method</th>
	<td>A function that operates on the type of the items in the <var>~~ArrayList~~</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.		<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities#Defining and invoking a local method\|local method]] or [[Method variables\|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes\|intrinsic]] (probably <var>Float</var>) value.
	<p>		<p>
	The default <var class="term">method</var> value is the special identity function, <var>This</var>, which simply returns the item value.</p></td></tr>		The default <var class="term">method</var> value is the special identity function, <var>This</var>, which simply returns the item value.</p></td></tr>
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>~~ArrayList~~</var> item values		<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values
	before performing the <var>Average</var> method's operation.		before performing the <var>Average</var> method's operation.
	If your <var>~~ArrayList~~</var>'s items are not intrinsic values, you must specify a function that can map the item values to intrinsic values or the method will fail.		If your <var>Arraylist</var>'s items are not intrinsic values, you must specify a function that can map the item values to intrinsic values or the method will fail.
	<p>		<p>
	For example, for an <var>~~ArrayList~~</var> that is a list of coordinates, you could		For example, for an <var>Arraylist</var> that is a list of coordinates, you could
	return the average of their distance from the origin by first applying a local function as the <var>Average</var> method's <var class="term">method</var> parameter: </p>		return the average of their distance from the origin by first applying a local function as the <var>Average</var> method's <var class="term">method</var> parameter: </p>
	<p class="code">b		<p class="code">b

JAL2 at 18:49, 10 July 2012

2012-07-10T18:49:38Z

← Older revision		Revision as of 18:49, 10 July 2012
Line 1:		Line 1:
	{{Template:Arraylist:Average subtitle}}		{{Template:Arraylist:Average subtitle}}

	~~This page is [[under construction]].~~

	==Syntax==		==Syntax==

JAL2 at 18:49, 10 July 2012

2012-07-10T18:49:23Z

@@ Line 8: / Line 8: @@
 ===Syntax terms===
 <table class="syntaxTable">
-<tr><th>%average</th><td>number</td></tr>
+<tr><th>%average</th>
 <tr><th>al</th>
-<td>Arraylist object</td></tr>
+<td>An <var>Arraylist</var> object.</td></tr>
 <tr><th>method</th>
-<td><var>ItemFunction</var> object</td></tr>
+<td>A function that operates on the type of the items in the <var>ArrayList</var>. It may be a [[Local and Common entities#Defining and invoking a local method|local method]] or [[Method variables|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes|intrinsic]] (probably <var>Float</var>) value.
 </table>
 ==Usage notes==
 ==Examples==