$Arr Max: Difference between revisions
(Automatically generated page update) |
(Automatically generated page update) |
||
| Line 10: | Line 10: | ||
</p> | </p> | ||
<p>%result indicates the element number of the maximum value in the array, or indicates a -1 if array or maxnum is invalid.</p> | <p><var class="term">%result</var> indicates the element number of the maximum value in the array, or indicates a -1 if array or maxnum is invalid.</p> | ||
The first argument is 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. | The first argument is 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. | ||
Revision as of 18:44, 19 July 2013
Find maximum value in array
Note: Most Sirius $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 indicates the element number of the maximum value in the array, or indicates a -1 if array or maxnum is invalid.
The first argument is 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.
The second argument is 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.