MinimumItem (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 20: Line 20:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values before performing the  
<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values before performing the <var>MinimumItem</var> method's item matching.
<var>MinimumItem</var> method's item matching.
The <var class="term">method</var> default (identity function <var>This</var>) fails against non-intrinsic values, however. If your <var>Arraylist</var> items are <i>not</i> intrinsic values, you must specify a <var class="term">method</var> function that can map the item values to intrinsic values.
If your <var>Arraylist</var> items are not intrinsic values, you must specify a <var class="term">method</var> function that can map the item values to intrinsic values or the method will fail.
</ul>
</ul>



Revision as of 20:19, 18 July 2012

Get item that has minimum value (Arraylist class)

[Introduced in Sirius Mods 7.8]


MinimumItem is related to the Minimum Arraylist method, which return the number or name of the item that has the minimum value in an Arraylist.

Syntax

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

Syntax terms

%item An Arraylist item of the same type as the al object.
al An Arraylist object.
method A function that operates on the type of the items in the Arraylist. It may be a local method or method variable or a class member (Variable, Property), and it must return an intrinsic value. The default method value is the special identity function, This, which simply returns the item value.

Usage notes

  • The optional method parameter lets you further manipulate the Arraylist item values before performing the MinimumItem method's item matching. The method default (identity function This) fails against non-intrinsic values, however. If your Arraylist items are not intrinsic values, you must specify a method function that can map the item values to intrinsic values.

Examples

For the ArrayList %al whose items are the odd integers between 0 and 10, %al:minItem returns 1.

See also