MinimumItem (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 15: Line 15:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the collection item values before performing the <var>MinimumItem</var> method's item matching.
<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the collection item values before performing the <var>MinimumItem</var> method's item evaluation.
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.
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>
</ul>

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

See also