Maximum (Arraylist function)

<section begin=dpl_desc/>Get item that has maximum value<section end=dpl_desc/>

Maximum is a member of the Arraylist class.

This function returns the number of the Arraylist item that has the maximum 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 Maximum, 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..

Maximum is available in Sirius Mods version 7.3 and later.

Syntax

  %num = %arrayl:Maximum(function)

Syntax Terms

%num

A numeric variable to contain the item number of the item in the indicated Arraylist that has the maximum value after the argument function is 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 Maximum returns string values, Maximum uses the decimal-equivalent value of the character bytes and determines the number of the item that has the greatest value. Therefore, lowercase letters are ranked alphabetically and the maximum lowercase letter is “z”; the uppercase letters are ranked alphabetically and the maximum uppercase letter is “Z”; “z” ranks lower than all the uppercase letters; and all letters rank lower than any number.
• If two or more Arraylist items have equal, maximum, values, Maximum returns the position of the item that appears closest to the beginning of the Arraylist.
• The parameter for Maximum 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 Maximum parameter. The "example of Maximum/Minimum with local method" shows a way to apply ToIntegerPower with Maximum.
• The Minimum function is the opposite of the Maximum function.

Examples

1. In the following example, the Maximum and Minimum methods first apply the Stringlist Count function, then return the position of the Arraylist item Stringlist that has the most items and the one that has the fewest. The Stringlist List function simplifies the construction of the lists.

       b
       %list1 is object stringlist
       %list2 is object stringlist
       %list3 is object stringlist
   
       %list1 = List('the', 'quick', 'brown')
       %list2 = List('fox', 'jumped', 'over', 'the')
       %list3 = List('lazy', 'dog', 'yesterday', 'two', 'times')
   
       %arrayl is collection arraylist of object stringlist
       %arrayl = List(%list1, %list2, %list3)
   
       PrintText {~} is {%arrayl:maximum(count)}
       PrintText {~} is {%arrayl:minimum(count)}
       end
   

   The result is:

       %arrayl:maximum(count) is 3
       %arrayl:minimum(count) is 1
   
2. The local method used with Maximum in the following request applies the ToIntegerPower method, which (because it requires its own argument) the syntax of Maximum does not allow as a parameter.

       b
       %alist is collection arraylist of float
       %alist = List(10, -11, 0, 11)
   
       local function (float):Squared is float
          return %this:toIntegerPower(2)
       end function
   
       PrintText {~} is {%alist:maximum(Squared)}
       PrintText {~} is {%alist:minimum(Squared)}
   
       end
   

   The result is:

       %arrayl:maximum(Squared) is 2
       %arrayl:minimum(Squared) is 3
   

   Although applying the local method above to item 2 and item 4 produces the same value, Maximum returns the item that is closer to the beginning of the arraylist.