StandardDeviation (GenericNamedArraylist function): Difference between revisions
m (→Syntax terms) |
m (→Usage notes) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:StandardDeviation subtitle}} | {{Template:GenericNamedArraylist:StandardDeviation subtitle}} | ||
This | 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== | ==Syntax== | ||
{{Template:GenericNamedArraylist:StandardDeviation syntax}} | {{Template:GenericNamedArraylist:StandardDeviation 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> | <td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr> | ||
<tr><th>itemFunction</th> | <tr><th>itemFunction</th> | ||
<td><var> | <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> | ||
==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 standard deviation. | |||
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>StandardDeviation</var> [[StandardDeviation (Arraylist function)#Usage notes|"Usage notes"]] section. </p> | |||
</ul> | |||
==Examples== | ==Examples== | ||
This request calculates the standard deviation of the items in a <var>NamedArraylist</var>: | |||
<p class="code">b | |||
%nl is namedarrayList of float | |||
%nl = new | |||
%nl('April') = 3000 | |||
%nl('May') = 5000 | |||
%nl('June') = 8000 | |||
[[Targeted Text statements|printText]] {~} is {%nl:standardDeviation} | |||
end | |||
</p> | |||
The result is: | |||
<p class="output">%nl:standardDeviation is 2054.80466765633 | |||
</p> | |||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:StandardDeviation footer}} | {{Template:GenericNamedArraylist:StandardDeviation footer}} | ||
Latest revision as of 20:09, 16 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 | A 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 standard deviation.
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 StandardDeviation "Usage notes" section.
Examples
This request calculates the standard deviation of the items in a NamedArraylist:
b %nl is namedarrayList of float %nl = new %nl('April') = 3000 %nl('May') = 5000 %nl('June') = 8000 printText {~} is {%nl:standardDeviation} end
The result is:
%nl:standardDeviation is 2054.80466765633