MaximumItem (Arraylist function)

From m204wiki
Revision as of 22:03, 17 July 2012 by JAL2 (talk | contribs)
Jump to navigation Jump to search

Get item that has maximum value (Arraylist class)

[Introduced in Sirius Mods 7.8]


MaximumItem is related to the Maximum Arraylist method, which return the number or name of the item that has the maximum value in an Arraylist.

Syntax

%item = al:MaximumItem[( [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 (probably Float) 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 MaximumItem method's item matching. If your Arraylist items are not intrinsic values, you must specify a method function that can map the item values to intrinsic values or the method will fail.

Examples

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

See also