$Arr Min - Revision history

DCameron at 12:14, 9 January 2018

2018-01-09T12:14:19Z

← Older revision		Revision as of 12:14, 9 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$Arr_Min</var> function, because the OO methods emphasize the use of [[Collections]] over the use of arrays.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$Arr_Min</var> 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> can be used to find the minimum value in an [[Using_variables_and_values_in_computation#.25Variable_arrays\|array]].
	If the minimum value occurs in multiple array elements, <var>$Arr_Min</var> always returns the lowest array element number containing that value.		If the minimum value occurs in multiple array elements, <var>$Arr_Min</var> always returns the lowest array element number containing that value.

JAL: add italics

2018-01-08T20:46:17Z

add italics

← Older revision		Revision as of 20:46, 8 January 2018
Line 8:		Line 8:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = $Arr_Min (array, maxnum)		<p class="syntax"><span class="term">%result</span> = $Arr_Min (<span class="term">array, maxnum</span>)
	</p>		</p>

JAL: misc formatting

2018-01-08T20:30:45Z

misc formatting

← Older revision		Revision as of 20:30, 8 January 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Find minimum value in array</span>		<span class="pageSubtitle">Find minimum value in array</span>

	<p class="warn"><b>Note: </b>~~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>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$Arr_Min</var> 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.~~		<var>$Arr_Min</var> can be used to find the minimum value in an array.
			If the minimum value occurs in multiple array elements, <var>$Arr_Min</var> always returns the lowest array element number containing that value.
	~~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==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = $Arr_Min (array, maxnum)		<p class="syntax"><span class="term">%result</span> = $Arr_Min (array, maxnum)
	</p>		</p>
	~~<p>~~
	</p>		<table>
	<p><~~var class="term"~~>%result</~~var~~> ~~indicates~~ the element number of the minimum value ~~in the array~~, or ~~indicates~~ a -1 if array or maxnum is invalid.</p>		<tr><th>%result</th>
			<td>A numeric variable that is set to the array element number that contains the indicated minimum value, or it is set to a -1 if the array or <var class="term">maxnum</var> is invalid.</td></tr>

			<tr><th>array</th>
			<td>An array of string, float, or fixed values. This array must be a single dimensional array and must not be an array in an [[Images\|image]].</td></tr>

			<tr><th>maxnum</th>
			<td>The highest array element number to check. This argument can be used to limit the search to the first <var class="term">n</var> elements in an array, where <var class="term">n</var> is a positive integer.</td></tr>
			</table>

	==Examples==		==Examples==
	In the following example		In the following example:
	<p class="code"> %FXARRAY IS FIXED ARRAY(5)		<p class="code"> %FXARRAY IS FIXED ARRAY(5)

Line 28:		Line 32:
	%NUM = $Arr_Min(%FXARRAY)		%NUM = $Arr_Min(%FXARRAY)
	</p>		</p>
	~~%NUM is set to 4.~~

	In the following example		<code>%NUM</code> is set to 4.

			In the following example:
	<p class="code"> %STARRAY IS STRING LEN 20 ARRAY(5)		<p class="code"> %STARRAY IS STRING LEN 20 ARRAY(5)

Line 40:		Line 45:
	%NUM = $Arr_Min(%STARRAY, 3)		%NUM = $Arr_Min(%STARRAY, 3)
	</p>		</p>
	%NUM is set to 1.
			<code>%NUM</code> is set to 1.

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
Line 53:		Line 59:
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>


	[[Category:$Functions\|$Arr_Min]]		[[Category:$Functions\|$Arr_Min]]

JALWiccan: Automatically generated page update

2015-02-19T23:08:52Z