$Arr_Min

From m204wiki
Revision as of 15:44, 31 January 2011 by Admin (talk | contribs) (1 revision)
Jump to navigation Jump to search

<section begin="desc" />Find minimum value in array<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Arr_Min function is to be entered.

$Arr_Min can be used to find the minimum value in an array. $Arr_Min accepts two arguments and returns a numeric code.

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.

If the minimum value occurs in multiple array elements, $Arr_Min always returns the lowest array element number containing that value.

Syntax

<section begin="syntax" /> %RESULT = $Arr_Min (array, maxnum) <section end="syntax" />

$Arr_Min Function

%RESULT indicates the element number of the minimum value in the array, or indicates a -1 if array or maxnum is invalid.


In the following example

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

%NUM is set to 4.

In the following example

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

%NUM is set to 1.

Products authorizing $Arr_Min