$Arr_Max

From m204wiki
Revision as of 20:21, 8 January 2018 by JAL (talk | contribs) (misc formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Find maximum value in array

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Arr_Max function because the OO methods emphasize the use of Collections over the use of arrays.

$Arr_Max can be used to find the maximum value in an array.

Syntax

%result = $Arr_Max (array, maxnum)

%result A numeric variable that is set to the array element number that contains the indicated maximum value, or it is set to a -1 if the array or maxnum is invalid.
array An array of string, float, or fixed values. This array must be a single dimensional array and must not be an array in an image.
maxnum The highest array element number to check. This argument can be used to limit the search to the first n elements in an array, where n is a positive integer.

Usage notes

  • If the maximum value occurs in multiple array elements, $Arr_Max always returns the lowest array element number containing that value.

Examples

In the following example

%FXARRAY IS FIXED ARRAY(5) %FXARRAY(1) = 81 %FXARRAY(2) = 49 %FXARRAY(3) = 121 %FXARRAY(4) = 25 %NUM = $Arr_Max(%FXARRAY)

%NUM is set to 3.

In the following example

%STARRAY IS STRING LEN 20 ARRAY(5) %STARRAY(1) = 'HOMER' %STARRAY(2) = 'MARGE' %STARRAY(3) = 'BART' %STARRAY(4) = 'KRUSTY' %STARRAY(5) = 'SELMA' %NUM = $Arr_Max(%STARRAY, 4)

%NUM is set to 2.

Products authorizing $Arr_Max