StandardDeviation (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
Line 11: | Line 11: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td> | <td>A <var>Float</var> variable to contain the numeric result.</td></tr> | ||
<tr><th>anyNal</th> | <tr><th>anyNal</th> |
Revision as of 21:28, 12 July 2012
Calculate standard deviation of items or function of items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
[Introduced in Sirius Mods 7.8]
This method returns by default the standard deviation of the values of the items in the collection, or the standard deviation after a specified function has been applied to the items.
The standard deviation measures the variation from the mean of the collection items; it is the square root of the collection's variance.
Syntax
%number = anyNal:StandardDeviation[( [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. |