Minimum (NamedArraylist function) - Revision history

JAL: /* Usage notes */

2012-11-01T19:57:49Z

Usage notes

← Older revision		Revision as of 19:57, 1 November 2012
Line 24:		Line 24:
	<ul>		<ul>
	<li>If <var class="term">itemFunction</var> returns <var>String</var> or <var>Unicode</var> values, <var>Minimum</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine which item has the least value. If <var class="term">itemFunction</var> returns a numeric type, numeric comparisons are used. See the [[#Examples\|"example"]] below.		<li>If <var class="term">itemFunction</var> returns <var>String</var> or <var>Unicode</var> values, <var>Minimum</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine which item has the least value. If <var class="term">itemFunction</var> returns a numeric type, numeric comparisons are used. See the [[#Examples\|"example"]] below.

	<li>If the values returned by <var class="term">itemFunction</var> for two or more <var>NamedArraylist</var> items are equal, minimum, values, <var>Minimum</var> returns the name of that item which is closest to the beginning of the <var>NamedArraylist</var>.		<li>If the values returned by <var class="term">itemFunction</var> for two or more <var>NamedArraylist</var> items are equal, minimum, values, <var>Minimum</var> returns the name of that item which is closest to the beginning of the <var>NamedArraylist</var>.

	<li>The <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> function is the opposite of the <var>Minimum</var> function.		<li>The <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> function is the opposite of the <var>Minimum</var> function.

	<li>The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.		<li>The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.
	That is, you cannot provide a function that itself has an argument		That is, you cannot provide a function that itself has an argument
	(say, <tt>ToIntegerPower(2)</tt>) as the <var>Minimum</var> parameter.		(say, <code>ToIntegerPower(2)</code>) as the <var>Minimum</var> parameter.
	Example [[Maximum (Arraylist function)\|"Maximum/Minimum with local method"]] shows a way to apply <var>ToIntegerPower</var>		Example [[Maximum (Arraylist function)\|"Maximum/Minimum with local method"]] shows a way to apply <var>ToIntegerPower</var>
	with the <var>Maximum</var> or <var>Minimum</var> method for an <var>Arraylist</var>.		with the <var>Maximum</var> or <var>Minimum</var> method for an <var>Arraylist</var>.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol>		<ol>

JAL: /* Syntax terms */

2012-11-01T19:56:42Z

Syntax terms

← Older revision		Revision as of 19:56, 1 November 2012
Line 10:		Line 10:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to contain the name of the item in <var class="term">nal</var>, the method object <var>NamedArraylist</var>, that has the minimum value as returned by the argument function. </td></tr>		<td>A string variable to contain the name of the item in <var class="term">nal</var>, the method object <var>NamedArraylist</var>, that has the minimum value as returned by the argument function. </td></tr>

	<tr><th>nal</th>		<tr><th>nal</th>
	<td>A <var>NamedArraylist</var> object. </td></tr>		<td>A <var>NamedArraylist</var> object. </td></tr>

	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>A method value (a method name literal, a method variable, or even a method that returns a method value) that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns an intrinsic value.		<td>A method value (a method name literal, a method variable, or even a method that returns a method value) that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns an intrinsic value.

	As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the <var>Minimum</var> and <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>		As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <var>This</var>, is the default ''function'' value for the <var>Minimum</var> and <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>

	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

Dme at 22:47, 10 August 2012

2012-08-10T22:47:08Z

@@ Line 1: / Line 1: @@
 {{Template:NamedArraylist:Minimum subtitle}}
-This function returns the name (subscript) of the <var>NamedArraylist</var> item that has
+<var>Minimum</var> returns the name of the <var>NamedArraylist</var> item that has the minimum value as returned by a specified function.  The function applied to each <var>NamedArraylist</var> item, which you specify with the required <var class="term">itemFunction</var> argument, must be a method that operates on the item type and returns a <var class="product">User Language</var> [[Intrinsic classes|intrinsic]] datatype (<var>Float</var>, <var>String</var>, or <var>Unicode</var>) value.
-the minimum value after the application of a specified function to each item.
 <var>Minimum</var> is available in <var class="product">Sirius Mods</var> version 7.3 and later.
 ==Syntax==
@@ Line 17: / Line 9: @@
 <table class="syntaxTable">
 <tr><th>%string</th>
-<td>A string variable to contain the subscript name of the item in <var class="term">nal</var>, the method object <var>NamedArraylist</var>, that has the minimum value after the argument function has been applied. </td></tr>
+<td>A string variable to contain the name of the item in <var class="term">nal</var>, the method object <var>NamedArraylist</var>, that has the minimum value as returned by the argument function. </td></tr>
 <tr><th>nal</th>
 <td>A <var>NamedArraylist</var> object. </td></tr>
 <tr><th>itemFunction</th>
-<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value.
+<td>A method value (a method name literal, a method variable, or even a method that returns a method value) that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns an intrinsic value.
 As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the <var>Minimum</var> and <var>[[Maximum (NamedArraylist function)|Maximum]]</var> methods. See [[Collections#Using the This function as the Maximum parameter|"Using the This function as the Maximum parameter"]].</td></tr>
 </table>
 ==Usage notes==
 <ul>
-<li>If the function applied by <var>Minimum</var> returns string values, <var>Minimum</var>
+<li>If <var class="term">itemFunction</var> returns <var>String</var> or <var>Unicode</var> values, <var>Minimum</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine which item has the least value. If <var class="term">itemFunction</var> returns a numeric type, numeric comparisons are used. See the [[#Examples|"example"]] below.
-uses the decimal-equivalent value of the character bytes and determines
+<li>If the values returned by <var class="term">itemFunction</var> for two or more <var>NamedArraylist</var> items are equal, minimum, values, <var>Minimum</var> returns the name of that item which is closest to the beginning of the <var>NamedArraylist</var>.
 <li>The <var>[[Maximum (NamedArraylist function)|Maximum]]</var> function is the opposite of the <var>Minimum</var> function.
 <li>The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.
@@ Line 44: / Line 29: @@
 Example [[Maximum (Arraylist function)|"Maximum/Minimum with local method"]] shows a way to apply <var>ToIntegerPower</var>
 with the <var>Maximum</var> or <var>Minimum</var> method for an <var>Arraylist</var>.
 </ul>
 ==See also==
 {{Template:NamedArraylist:Minimum footer}}

JAL2 at 19:08, 19 March 2012

2012-03-19T19:08:31Z

← Older revision		Revision as of 19:08, 19 March 2012
Line 6:		Line 6:
	you identify in the argument to <var>Minimum</var>, must be a method		you identify in the argument to <var>Minimum</var>, must be a method
	that operates on the item type and returns a <var class="product">User Language</var> intrinsic		that operates on the item type and returns a <var class="product">User Language</var> intrinsic
	datatype (Float, String, Longstring, or Unicode) value.		datatype (<var>Float</var>, <var>String</var>, <var>Longstring</var>, or <var>Unicode</var>) value.

	The system intrinsic classes are discussed in [[Intrinsic classes\|"Intrinsic classes"]], and		The system intrinsic classes are discussed in [[Intrinsic classes\|"Intrinsic classes"]], and
Line 23:		Line 23:
	<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value.		<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value.

	As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the Minimum and Maximum methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>		As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the <var>Minimum</var> and <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>

	</table>		</table>
Line 29:		Line 29:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by Minimum returns string values, Minimum		<li>If the function applied by <var>Minimum</var> returns string values, <var>Minimum</var>
	uses the decimal-equivalent value of the character bytes and determines		uses the decimal-equivalent value of the character bytes and determines
	the number of the item that has the lowest value.		the number of the item that has the lowest value.
	Therefore, lowercase letters are ranked alphabetically and		Therefore, lowercase letters are ranked alphabetically and the minimum lowercase letter is "a";
	the minimum lowercase letter is "a";		the uppercase letters are ranked alphabetically and the minimum uppercase letter is "A";
	the uppercase letters are ranked alphabetically and		"z" ranks lower than all the uppercase letters; and all letters rank lower than any number.
	the minimum uppercase letter is "A";		<li>If one or more <var>NamedArraylist</var> items have equal, minimum, values,
	"z" ranks lower than all the uppercase letters;		<var>Minimum</var> returns the name of the item that appears closest to the beginning
	and all letters rank lower than any number.		of the <var>NamedArraylist</var>.
	<li>If one or more NamedArraylist items have equal, minimum, values,		<li>The <var>[[Maximum (NamedArraylist function)\|Maximum]]</var> function is the opposite of the <var>Minimum</var> function.
	Minimum returns the name of the item that appears closest to the beginning		<li>The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.
	of the NamedArraylist.
	<li>The [[Maximum (NamedArraylist function)\|Maximum]] function is the opposite of the Minimum function.
	<li>The parameter for Minimum is a method value, not a <var class="product">User Language</var> expression.
	That is, you cannot provide a function that itself has an argument		That is, you cannot provide a function that itself has an argument
	(say, <tt>ToIntegerPower(2)</tt>) as the Minimum parameter.		(say, <tt>ToIntegerPower(2)</tt>) as the <var>Minimum</var> parameter.
	Example [[Maximum (Arraylist function)\|"Maximum/Minimum with local method"]] shows a way to apply ToIntegerPower		Example [[Maximum (Arraylist function)\|"Maximum/Minimum with local method"]] shows a way to apply <var>ToIntegerPower</var>
	with the Maximum or Minimum method for an Arraylist.		with the <var>Maximum</var> or <var>Minimum</var> method for an <var>Arraylist</var>.
	<li>For an example of the Minimum method for a NamedArraylist,		<li>For an example of the <var>Minimum</var> method for a <var>NamedArraylist</var>,
	see [[Maximum (NamedArraylist function)#Examples\|"NamedArraylist Maximum function example"]], and also see [[Collections#Finding collection maxima and minima, and sorting\|"Finding collection maxima and minima, and sorting"]].		see [[Maximum (NamedArraylist function)#Examples\|"NamedArraylist Maximum function example"]], and also see [[Collections#Finding collection maxima and minima, and sorting\|"Finding collection maxima and minima, and sorting"]].
	</ul>		</ul>
	==See also==		==See also==
	{{Template:NamedArraylist:Minimum footer}}		{{Template:NamedArraylist:Minimum footer}}

JALWiccan: 1 revision

2012-03-19T18:44:13Z

1 revision

← Older revision	Revision as of 18:44, 19 March 2012
(No difference)

Dme: /* Syntax terms */

2012-03-19T18:44:12Z

Syntax terms

← Older revision		Revision as of 18:44, 19 March 2012
Line 5:		Line 5:
	The function that gets applied to each <var>NamedArraylist</var> item, which		The function that gets applied to each <var>NamedArraylist</var> item, which
	you identify in the argument to <var>Minimum</var>, must be a method		you identify in the argument to <var>Minimum</var>, must be a method
	that operates on the item type and returns a User Language intrinsic		that operates on the item type and returns a <var class="product">User Language</var> intrinsic
	datatype (Float, String, Longstring, or Unicode) value.		datatype (Float, String, Longstring, or Unicode) value.

Line 42:		Line 42:
	of the NamedArraylist.		of the NamedArraylist.
	<li>The [[Maximum (NamedArraylist function)\|Maximum]] function is the opposite of the Minimum function.		<li>The [[Maximum (NamedArraylist function)\|Maximum]] function is the opposite of the Minimum function.
	<li>The parameter for Minimum is a method value, not a User Language expression.		<li>The parameter for Minimum is a method value, not a <var class="product">User Language</var> expression.
	That is, you cannot provide a function that itself has an argument		That is, you cannot provide a function that itself has an argument
	(say, <tt>ToIntegerPower(2)</tt>) as the Minimum parameter.		(say, <tt>ToIntegerPower(2)</tt>) as the Minimum parameter.

Dme: /* Syntax terms */

2012-02-08T12:35:22Z

Syntax terms

← Older revision		Revision as of 12:35, 8 February 2012
Line 17:		Line 17:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to contain the subscript name of the item in ~~the~~ <var class="term">nal</var> method object <var>NamedArraylist</var> that has the minimum value after the argument function has been applied. </td></tr>		<td>A string variable to contain the subscript name of the item in <var class="term">nal</var>, the method object <var>NamedArraylist</var>, that has the minimum value after the argument function has been applied. </td></tr>
	<tr><th>nal</th>		<tr><th>nal</th>
	<td>A <var>NamedArraylist</var> object. </td></tr>		<td>A <var>NamedArraylist</var> object. </td></tr>
Line 26:		Line 26:

	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

Dme at 12:22, 8 February 2012

2012-02-08T12:22:57Z

← Older revision		Revision as of 12:22, 8 February 2012
Line 1:		Line 1:
	{{Template:NamedArraylist:Minimum subtitle}}		{{Template:NamedArraylist:Minimum subtitle}}

	This function returns the name (subscript) of the NamedArraylist item that has		This function returns the name (subscript) of the <var>NamedArraylist</var> item that has
	the minimum value after the application of a specified function to each item.		the minimum value after the application of a specified function to each item.
	The function that gets applied to each NamedArraylist item, which		The function that gets applied to each <var>NamedArraylist</var> item, which
	you identify in the argument to Minimum, must be a method		you identify in the argument to <var>Minimum</var>, must be a method
	that operates on the item type and returns a User Language intrinsic		that operates on the item type and returns a User Language intrinsic
	datatype (Float, String, Longstring, or Unicode) value.		datatype (Float, String, Longstring, or Unicode) value.

	The system intrinsic classes are discussed in [[Intrinsic classes\|"Intrinsic classes"]].		The system intrinsic classes are discussed in [[Intrinsic classes\|"Intrinsic classes"]], and
	Local methods are ~~discussed~~ in [[??]] ~~refid=localm.~~.		Local methods are disscussed in [[Local and Common entities\|"Local and Common entities"]].

	Minimum is available in <var class="product">Sirius Mods</var> version 7.3 and later.		<var>Minimum</var> is available in <var class="product">Sirius Mods</var> version 7.3 and later.
	==Syntax==		==Syntax==
	{{Template:NamedArraylist:Minimum syntax}}		{{Template:NamedArraylist:Minimum syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~str~~</th>		<tr><th>%string</th>
	<td>A string variable to contain the subscript name of the item in the ~~indicated~~ NamedArraylist that has the minimum value after the argument function has been applied. </td></tr>		<td>A string variable to contain the subscript name of the item in the <var class="term">nal</var> method object <var>NamedArraylist</var> that has the minimum value after the argument function has been applied. </td></tr>
	<tr><th>~~%namrayl~~</th>		<tr><th>nal</th>
	<td>A NamedArraylist object. </td></tr>		<td>A <var>NamedArraylist</var> object. </td></tr>
	<tr><th>~~function~~</th>		<tr><th>itemFunction</th>
	<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the ~~''%narrayl''~~ declaration and that returns a numeric or string value.		<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value.

	As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the Minimum and Maximum methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>		As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the Minimum and Maximum methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>

JALWiccan: 1 revision

2011-05-24T22:30:57Z

1 revision

← Older revision	Revision as of 22:30, 24 May 2011
(No difference)

JAL at 22:30, 24 May 2011

2011-05-24T22:30:56Z

← Older revision		Revision as of 22:30, 24 May 2011
Line 11:		Line 11:
	Local methods are discussed in [[??]] refid=localm..		Local methods are discussed in [[??]] refid=localm..

	Minimum is available in ''Sirius Mods'' version 7.3 and later.		Minimum is available in <var class="product">Sirius Mods</var> version 7.3 and later.
	==Syntax==		==Syntax==
	{{Template:NamedArraylist:Minimum syntax}}		{{Template:NamedArraylist:Minimum syntax}}
Line 23:		Line 23:
	<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the ''%narrayl'' declaration and that returns a numeric or string value.		<td>A method value (a method name literal, a method variable, or even a method that returns a method value) for a method that operates on objects of the type specified on the ''%narrayl'' declaration and that returns a numeric or string value.

	As of ''Sirius Mods'' version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the Minimum and Maximum methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>		As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, <tt>This</tt>, is the default ''function'' value for the Minimum and Maximum methods. See [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]].</td></tr>

	</table>		</table>