MinimumItem (GenericNamedArraylist function): Difference between revisions
m (→Syntax terms) |
m (→Examples) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:MinimumItem subtitle}} | {{Template:GenericNamedArraylist:MinimumItem subtitle}} | ||
<var>MinimumItem</var> is related to the <var>Minimum</var> collection methods, which return the number or name of the item that has the maximum value in a collection. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:MinimumItem syntax}} | {{Template:GenericNamedArraylist:MinimumItem syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
Line 23: | Line 25: | ||
==Examples== | ==Examples== | ||
For the <var>NamedArrayList</var> <code>%nal</code>, <var>Minimum</var> returns the index (item name) of the item that has the maximum value, while <var>MinimumItem</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:minimum} | |||
printText {~=%nal:minimumItem} | |||
end </p> | |||
The result is: | |||
<p class="output">%nal:minimum=New York | |||
%nal:minimumItem=-999 </p> | |||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:MinimumItem footer}} | {{Template:GenericNamedArraylist:MinimumItem footer}} |
Latest revision as of 23:15, 18 July 2012
Item with minimum value or minimum value of function applied to items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
[Introduced in Sirius Mods 7.8]
MinimumItem is related to the Minimum collection methods, which return the number or name of the item that has the maximum value in a collection.
Syntax
%item = anyNal:MinimumItem[( [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 MinimumItem 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
, Minimum returns the index (item name) of the item that has the maximum value, while MinimumItem 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:minimum} printText {~=%nal:minimumItem} end
The result is:
%nal:minimum=New York %nal:minimumItem=-999