MaximumItem (GenericNamedArraylist function): Difference between revisions
m (→Syntax terms) |
m (→Examples) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:MaximumItem subtitle}} | {{Template:GenericNamedArraylist:MaximumItem subtitle}} | ||
<var>MaximumItem</var> is related to the <var>Maximum</var> collection methods, which return the number or name of the item that has the maximum value in a collection. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:MaximumItem syntax}} | {{Template:GenericNamedArraylist:MaximumItem syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%item</th> | <tr><th>%item</th> | ||
<td>item</td></tr> | <td>A collection item of the same type as the <var class="term">anyNal</var> object.</td></tr> | ||
<tr><th>anyNal</th> | <tr><th>anyNal</th> | ||
<td> | <td>A <var>[[NamedArraylist class|NamedArraylist]]</var>, <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> object variable.</td></tr> | ||
<tr><th>itemFunction</th> | <tr><th>itemFunction</th> | ||
| Line 17: | Line 19: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the collection item values before performing the <var>MaximumItem</var> method's item evaluation. | |||
The <var class="term">itemFunction</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your collection items are <i>not</i> intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values. | |||
</ul> | |||
==Examples== | ==Examples== | ||
For the <var>NamedArrayList</var> <code>%nal</code>, <var>Maximum</var> returns the index (item name) of the item that has the maximum value, while <var>MaximumItem</var> returns the value of that item: | |||
<p class="code">b | |||
%nal is namedArraylist of float | |||
%nal = new | |||
%nal('Chicago') = 22 | |||
%nal('New York') = -999 | |||
%nal('Los Angeles') = 3.1415926 | |||
%nal('Philadelphia') = 1099 | |||
printText {~=%nal:maximum} | |||
printText {~=%nal:maximumItem} | |||
end </p> | |||
The result is: | |||
<p class="output">%nal:maximum=Philadelphia | |||
%nal:maximumItem=1099 </p> | |||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:MaximumItem footer}} | {{Template:GenericNamedArraylist:MaximumItem footer}} | ||
Latest revision as of 23:12, 18 July 2012
Item with maximum value or maximum value of function applied to items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
[Introduced in Sirius Mods 7.8]
MaximumItem is related to the Maximum collection methods, which return the number or name of the item that has the maximum value in a collection.
Syntax
%item = anyNal:MaximumItem[( [itemFunction])]
Syntax terms
| %item | A collection item of the same type as the anyNal object. |
|---|---|
| anyNal | A NamedArraylist, FloatNamedArraylist, or UnicodeNamedArraylist object variable. |
| 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 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 performing the MaximumItem method's item evaluation. The itemFunction default (identity function This) fails against non-intrinsic values, however. If your collection items are not intrinsic values, you must specify an itemFunction function that can map the item values to intrinsic values.
Examples
For the NamedArrayList %nal, Maximum returns the index (item name) of the item that has the maximum value, while MaximumItem returns the value of that item:
b %nal is namedArraylist of float %nal = new %nal('Chicago') = 22 %nal('New York') = -999 %nal('Los Angeles') = 3.1415926 %nal('Philadelphia') = 1099 printText {~=%nal:maximum} printText {~=%nal:maximumItem} end
The result is:
%nal:maximum=Philadelphia %nal:maximumItem=1099