Average (Arraylist function)

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.
itemFunction	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 itemFunction value is the special identity function, This, which simply returns the item value.

Usage notes

• The optional itemFunction parameter lets you further manipulate the Arraylist item values before calculating the average. The itemFunction default (identity function This) fails against non-intrinsic values, however. If your collection items are not intrinsic values, you must specify an itemFunction function that can map the item values to intrinsic values.

  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 itemFunction 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

This request calculates the average of a three-item Arraylist:

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

The result is:

5.33333333333333

See also

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods