Sum (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:Sum subtitle}} | {{Template:GenericNamedArraylist:Sum subtitle}} | ||
This | This method returns by default the sum of the values of the items in the collection, or it returns the sum of the items after a specified function has been applied to them. | ||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:Sum syntax}} | {{Template:GenericNamedArraylist:Sum syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th><td>number</td></tr> | <tr><th>%number</th> | ||
<td>number</td></tr> | |||
<tr><th>anyNal</th> | <tr><th>anyNal</th> | ||
<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>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. | <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. | ||
| Line 16: | Line 21: | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:Sum footer}} | {{Template:GenericNamedArraylist:Sum footer}} | ||
Revision as of 20:28, 12 July 2012
Calculate sum of items or function of items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
[Introduced in Sirius Mods 7.8]
This method returns by default the sum of the values of the items in the collection, or it returns the sum of the items after a specified function has been applied to them.
Syntax
%number = anyNal:Sum[( [itemFunction])]
Syntax terms
| %number | number |
|---|---|
| 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. |