Average (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 23: Line 23:


==Examples==
==Examples==
<p class="code">b
%nl is namedarrayList of float
%nl = new 
%nl('April') = 3000
%nl('May') = 5000
%nl('June') = 8000
print %nl:average
end
</p>
The result is:
<p class="output">5333.33333333333
</p>


==See also==
==See also==
{{Template:GenericNamedArraylist:Average footer}}
{{Template:GenericNamedArraylist:Average footer}}

Revision as of 22:12, 12 July 2012

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

[Introduced in Sirius Mods 7.8]


This method returns by default the average of the values of the items in the collection, or it returns the average of the items after a specified function has been applied to them.

Syntax

%number = anyNal:Average[( [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

Examples

b %nl is namedarrayList of float %nl = new %nl('April') = 3000 %nl('May') = 5000 %nl('June') = 8000 print %nl:average end

The result is:

5333.33333333333

See also