MaximumItem (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Usage notes) |
||
Line 17: | Line 17: | ||
==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 matching. | |||
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== | ||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:MaximumItem footer}} | {{Template:GenericNamedArraylist:MaximumItem footer}} |
Revision as of 20:51, 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]
This page is under construction.
Syntax
%item = anyNal:MaximumItem[( [itemFunction])]
Syntax terms
%item | item |
---|---|
anyNal | GenericNamedArraylist 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 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 matching. 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.