MaximumItem (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (→Syntax terms) |
||
Line 7: | Line 7: | ||
<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> |
Revision as of 21:06, 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 | 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.