Average (GenericNamedArraylist function): Difference between revisions

Revision as of 20:06, 12 July 2012

Calculate average of items or function of items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)

[Introduced in Sirius Mods 7.8]

%number = anyNal:Average[( [itemFunction])]

%number	A `Float` variable to contain the numeric result.
anyNal	An `FloatNamedArraylist`, `NamedArraylist`, or `UnicodeNamedArraylist` object.
itemFunction	A function that operates on the type of the items in the collection. 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.

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

@@ Line 10: / Line 10: @@
 <tr><th>%number</th>
 <td>A <var>Float</var> variable to contain the numeric result.</td></tr>
 <tr><th>anyNal</th>
-<td>GenericNamedArraylist object</td></tr>
+<td>An <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr>
 <tr><th>itemFunction</th>
 <td>A function that operates on the type of the items in the collection. 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.