MinimumItem (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 10: Line 10:
<td>GenericNamedArraylist object</td></tr>
<td>GenericNamedArraylist object</td></tr>
<tr><th>itemFunction</th>
<tr><th>itemFunction</th>
<td><var>ItemFunction</var> object<br/>This argument is optional; its default value is <var>This</var>.</td></tr>
<td>A function that operates on the type of the items in the collection. It may be a [[Local and Common entities|local method]] or [[Method variables|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes|intrinsic]] value. The default <var class="term">itemFunction</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter|This]]</var>, which simply returns the item value.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 20:54, 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]


This page is under construction.

Syntax

%item = anyNal:MinimumItem[( [itemFunction])]

Syntax terms

%itemitem
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 MinimumItem 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.

Examples

See also