Sum (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 10: Line 10:
<td>An <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr>
<td>An <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr>
<tr><th>itemFunction</th>
<tr><th>itemFunction</th>
<td><var>ItemFunction</var> object</td></tr>
<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>



Revision as of 20:15, 12 July 2012

Calculate sum 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:Sum[( [itemFunction])]

Syntax terms

%numbernumber
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.

Usage notes

Examples

See also