Minimum (Arraylist function)

Get number of minimum item (Arraylist class)

Minimum is a member of the Arraylist class.

This function returns the number of the Arraylist item that has the minimum numeric value after the application of a specified function to each item. The function that gets applied to each Arraylist item, which you identify in the argument to Minimum, must be a method that operates on the item type and returns a User Language intrinsic datatype (Float, String, Longstring, or Unicode) value.

The system intrinsic classes are discussed in "Intrinsic classes". Local methods are discussed in ?? refid=localm..

Minimum is available in Sirius Mods version 7.3 and later.

Syntax

%number = al:Minimum[( [itemFunction])]

Syntax terms

%num	A numeric variable to contain the item number of the item in the indicated Arraylist that has the minimum value after the argument method has been applied.
%arrayl	An Arraylist object.
function	A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on items of the type specified on the %arrayl declaration and that returns a numeric or string value. As of Sirius Mods version 7.6, the special identity function, This, is the default function value for the Maximum and Minimum methods. See "Using the This function as the Maximum parameter".

Usage notes

• If the function applied by Minimum returns string values, Minimum uses the decimal-equivalent value of the character bytes and determines the number of the item that has the lowest value. Therefore, lowercase letters are ranked alphabetically and the minimum lowercase letter is "a"; the uppercase letters are ranked alphabetically and the minimum uppercase letter is "A"; "z" ranks lower than all the uppercase letters; and all letters rank lower than any number.
• If one or more Arraylist items have equal, minimum, values, Minimum returns the position of the item that appears closest to the beginning of the Arraylist.
• The Maximum function is the opposite of the Minimum function.
• The parameter for Minimum is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, ToIntegerPower(2)) as the Minimum parameter. See "example of Maximum/Minimum with local method", which shows a way to apply ToIntegerPower with the Maximum or Minimum method.

Examples

In the following example, the Minimum and Maximum methods use the special method, This, which simply returns the item value. The List function simplifies the construction of the Arraylist.

    b
    %alist is collection arraylist of string len 12

    %alist = List('broken', 'br4ck', 'brown', 'Box', 'bumped')

    PrintText {~} is {%alist:minimum(this)}
    PrintText {~} is {%alist:maximum(this)}

    end

The result is:

    %alist:minimum(this) is 1
    %alist:maximum(this) is 4

As of Sirius Mods version 7.6, This is the default parameter for Minimum and Maximum. For more information about using This, see Using the This function as the Maximum parameter. For additional Minimum/Maximum examples, see the "Arraylist Maximum function examples", and also see "Finding collection maxima and minima, and sorting".