Average (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
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

Revision as of 18:57, 10 July 2012

Average the members of this ArrayList (Arraylist class)

[Introduced in Sirius Mods 7.8]


Syntax

%average = al:Average[( [itemFunction])]

Syntax terms

%average A Float variable to contain the numeric result.
al An Arraylist object.
method A function that operates on the type of the items in the Arraylist. It may be a local method or method variable or a class member (Variable, Property), and it must return an intrinsic (probably Float) value.

The default method value is the special identity function, This, which simply returns the item value.

Usage notes

  • The optional method parameter lets you further manipulate the Arraylist item values before performing the Average method's operation. If your Arraylist'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.

    For example, for an Arraylist 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 Average method's method parameter:

    b class point public constructor new(%x is float, %y is float) variable x is float variable y is float end public constructor new(%x is float, %y is float) %this:x = %x %this:y = %y end constructor end class local function (point):distance is float return (%this:x * %this:x + %this:y * %this:y):squareRoot end function %al is arrayList of object point %al = new %al:add(new(1,1)) %al:add(new(3,4)) %al:add(new(-5,12)) print %al:average(distance) end

    The result is 6.47140452079103.

Examples

b %al is arrayList of float %al = new %al:add(5) %al:add(3) %al:add(8) print %al:average end

The result is:

5.33333333333333

See also