Average (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
This page is [[under construction]]. | This page is [[under construction]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:Average syntax}} | {{Template:GenericNamedArraylist:Average syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th><td> | <tr><th>%number</th> | ||
<td>A <var>Float</var> variable to contain the numeric result.</td></tr> | |||
<tr><th>anyNal</th> | <tr><th>anyNal</th> | ||
<td>GenericNamedArraylist object</td></tr> | <td>GenericNamedArraylist object</td></tr> | ||
<tr><th>itemFunction</th> | <tr><th>itemFunction</th> | ||
<td><var> | <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. | ||
<p> | |||
The default <var class="term">itemFunction</var> value is the special identity function, <var>This</var>, which simply returns the item value.</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:Average footer}} | {{Template:GenericNamedArraylist:Average footer}} | ||
Revision as of 22:59, 11 July 2012
Calculate average of items or function of items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
[Introduced in Sirius Mods 7.8]
This page is under construction.
Syntax
%number = anyNal:Average[( [itemFunction])]
Syntax terms
| %number | A Float variable to contain the numeric result. |
|---|---|
| anyNal | GenericNamedArraylist 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. |