MaximumItem (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
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"> | ||
Line 23: | Line 25: | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:MaximumItem footer}} | {{Template:GenericNamedArraylist:MaximumItem footer}} |
Revision as of 21:08, 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.