View source for $Arr Min

{{DISPLAYTITLE:$Arr_Min}}
<span class="pageSubtitle">Find minimum value in array</span>

<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Arr_Min function because the OO methods emphasize the use of [[Collections]] over the use of arrays.</p>

<var>$Arr_Min</var> can be used to find the minimum value in an array. <var>$Arr_Min</var> 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, <var>$Arr_Min</var> always returns the lowest array element number containing that value.
==Syntax==
<p class="syntax"><section begin="syntax" />%result = $Arr_Min (array, maxnum)
<section end="syntax" /></p>
<p class="caption">$Arr_Min Function
</p>
<p class="caption">%result indicates the element number of the minimum value in the array, or indicates a -1 if array or maxnum is invalid.</p>


In the following example
<p class="code"> %FXARRAY IS FIXED ARRAY(5)
 
 %FXARRAY(1) = 81
 %FXARRAY(2) = 49
 %FXARRAY(3) = 121
 %FXARRAY(4) = 25
 %NUM = $Arr_Min(%FXARRAY)
</p>
%NUM is set to 4. 

In the following example
<p class="code"> %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)
</p>
%NUM is set to 1.
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Janus Open Client]]</li>
<li>[[Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Japanese functions]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>

</ul>
<p class="caption">Products authorizing $Arr_Min
</p>


[[Category:$Functions|$Arr_Min]]