MaximumItem (GenericNamedArraylist function)

Item with maximum value or maximum value of function applied to items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)

[Introduced in Sirius Mods 7.8]

MaximumItem is related to the Maximum collection methods, which return the number or name of the item that has the maximum value in a collection.

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.

Examples

For the NamedArrayList %nal, Maximum returns the index (item name) of the item that has the maximum value, while MaximumItem returns the value of that item:

b %nal is namedArraylist of float %nal = new %nal('Chicago') = 22 %nal('New York') = -999 %nal('Los Angeles') = 3.1415926 %nal('Philadelphia') = 1099 printText {~=%nal:maximum} printText {~=%nal:maximumItem} end

The result is:

%nal:maximum=Philadelphia %nal:maximumItem=1099

See also

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods