Sum (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Usage notes) |
||
| (3 intermediate revisions by the same user not shown) | |||
| 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> | <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>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== | ||
<ul> | |||
<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the collection item values | |||
before calculating the sum. | |||
If your collection items are not intrinsic values, you must specify a function that can map the item values to intrinsic values or the method will fail. | |||
<p> | |||
For an example, see the <var>Arraylist</var> <var>Sum</var> [[Sum (Arraylist function)#Usage notes|"Usage notes"]] section. </p> | |||
</ul> | |||
==Examples== | ==Examples== | ||
<p class="code">b | |||
%nl is namedarrayList of float | |||
%nl = new | |||
%nl('April') = 3000 | |||
%nl('May') = 5000 | |||
%nl('June') = 8000 | |||
print %nl:sum | |||
end | |||
</p> | |||
The result is: | |||
<p class="output">16000 | |||
</p> | |||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:Sum footer}} | {{Template:GenericNamedArraylist:Sum footer}} | ||
Latest revision as of 20:08, 16 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 | 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. |
Usage notes
- The optional itemFunction parameter lets you further manipulate the collection item values
before calculating the sum.
If your collection items are not intrinsic values, you must specify a function that can map the item values to intrinsic values or the method will fail.
For an example, see the Arraylist Sum "Usage notes" section.
Examples
b %nl is namedarrayList of float %nl = new %nl('April') = 3000 %nl('May') = 5000 %nl('June') = 8000 print %nl:sum end
The result is:
16000