SortNew (Arraylist function) - Revision history

JAL2: /* Usage notes */

2012-08-13T19:36:43Z

Usage notes

← Older revision		Revision as of 19:36, 13 August 2012
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>sortNew</var> returns <var>String</var> or <var>Unicode</var> values, <var>SortNew</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items.		<li>If the function applied by <var>sortNew</var> returns <var>String</var> or <var>Unicode</var> values, <var>SortNew</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. If the function returns a numeric type, numeric comparisons are used.

	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.

JAL2: /* Usage notes */

2012-08-09T23:13:26Z

Usage notes

← Older revision		Revision as of 23:13, 9 August 2012
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>sortNew</var> returns ~~string~~ values, <var>~~sortNew~~</var> uses the ~~decimal-equivalent value~~ of ~~the character bytes~~ to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. ~~Lowercase letters are first ranked alphabetically, then uppercase letters, also ranked alphabetically, followed by the numbers; ie: <code>'a'..'z','A'..'Z',0..9</code>.~~		<li>If the function applied by <var>sortNew</var> returns <var>String</var> or <var>Unicode</var> values, <var>SortNew</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items.

	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.

	<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.

	<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.

	<li><var>SortNew</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.		<li><var>SortNew</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.
	</ul>		</ul>

JAL2: /* Usage notes */

2012-03-19T19:48:00Z

Usage notes

← Older revision		Revision as of 19:48, 19 March 2012
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>sortNew</var> returns string values, <var>sortNew</var> uses the decimal-equivalent value of the character bytes to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. Lowercase letters are first ranked alphabetically, then ~~upper case~~ letters, also ranked alphabetically, followed by the numbers; ie: <code>'a'..'z','A'..'Z',0..9</code>.		<li>If the function applied by <var>sortNew</var> returns string values, <var>sortNew</var> uses the decimal-equivalent value of the character bytes to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. Lowercase letters are first ranked alphabetically, then uppercase letters, also ranked alphabetically, followed by the numbers; ie: <code>'a'..'z','A'..'Z',0..9</code>.
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.
	<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.

JAL2: /* Usage notes */

2012-03-19T18:55:04Z

Usage notes

← Older revision		Revision as of 18:55, 19 March 2012
Line 28:		Line 28:
	<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.
	<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.
	<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.3 and later.		<li><var>SortNew</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.
	</ul>		</ul>

JALWiccan: 1 revision

2012-03-19T18:44:11Z

1 revision

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

JAL2 at 18:44, 19 March 2012

2012-03-19T18:44:10Z

← Older revision		Revision as of 18:44, 19 March 2012
Line 26:		Line 26:
	<li>If the function applied by <var>sortNew</var> returns string values, <var>sortNew</var> uses the decimal-equivalent value of the character bytes to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. Lowercase letters are first ranked alphabetically, then upper case letters, also ranked alphabetically, followed by the numbers; ie: <code>'a'..'z','A'..'Z',0..9</code>.		<li>If the function applied by <var>sortNew</var> returns string values, <var>sortNew</var> uses the decimal-equivalent value of the character bytes to determine the ascending or descending alphabetic order of the associated <var class="term">al</var> items. Lowercase letters are first ranked alphabetically, then upper case letters, also ranked alphabetically, followed by the numbers; ie: <code>'a'..'z','A'..'Z',0..9</code>.
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.
	<li>The function in the parameter for <var>SortNew</var> is a method value, not a User Language expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.
	<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.
	<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.		<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.

JAL2 at 21:51, 30 November 2011

2011-11-30T21:51:43Z

← Older revision		Revision as of 21:51, 30 November 2011
Line 2:		Line 2:

	<var>SortNew</var> sorts the method object <var>Arraylist</var> returning the sorted result in a new <var>Arraylist</var>. The sort is based on one or more sort criteria, each of which consists of a sorting direction (ascending or descending) paired with a sort key (a function that gets applied to an <var>Arraylist</var> item). The sort criteria pairs are passed to <var>SortNew</var> as a <var>[[SortOrder class\|SortOrder]]</var> argument.		<var>SortNew</var> sorts the method object <var>Arraylist</var> returning the sorted result in a new <var>Arraylist</var>. The sort is based on one or more sort criteria, each of which consists of a sorting direction (ascending or descending) paired with a sort key (a function that gets applied to an <var>Arraylist</var> item). The sort criteria pairs are passed to <var>SortNew</var> as a <var>[[SortOrder class\|SortOrder]]</var> argument.
	<p>Each sort key function (~~that~~ is applied to the <var>Arraylist</var> items) must operate on the item type and return an <var>[[Intrinsic classes\|intrinsic]]</var> datatype (<var>Float</var>, <var>String</var>, <var>Longstring</var>, or <var>Unicode</var>) value. The values returned by the function are sorted into ascending or descending order to determine the position of their associated item in the new <var>Arraylist</var>.</p>		<p>Each sort key function (which is applied to the <var>Arraylist</var> items) must operate on the item type and return an <var>[[Intrinsic classes\|intrinsic]]</var> datatype (<var>Float</var>, <var>String</var>, <var>Longstring</var>, or <var>Unicode</var>) value. The values returned by the function are sorted into ascending or descending order to determine the position of their associated item in the new <var>Arraylist</var>.</p>

	==Syntax==		==Syntax==

Dme at 20:24, 30 November 2011

2011-11-30T20:24:59Z

← Older revision		Revision as of 20:24, 30 November 2011
Line 1:		Line 1:
	{{Template:Arraylist:SortNew subtitle}}		{{Template:Arraylist:SortNew subtitle}}

	<var>SortNew</var> sorts the method object <var>Arraylist</var> returning the sorted result in a new <var>Arraylist</var>. The sort is based on one or more ~~<var>[[SortOrder_class\|sortCriteria]]</var>~~ which ~~consist~~ of a sorting direction (ascending or descending) paired with a sort key (a function that gets applied to ~~each~~ <var>Arraylist</var> item). ~~Each~~ sort ~~criterion pair is~~ a <var>[[SortOrder class~~#SortOrder object variable declaration syntax~~\|SortOrder ~~object~~]]</var>~~, and multiple pairs are a <var>SortOrder</var> collection~~.		<var>SortNew</var> sorts the method object <var>Arraylist</var> returning the sorted result in a new <var>Arraylist</var>. The sort is based on one or more sort criteria, each of which consists of a sorting direction (ascending or descending) paired with a sort key (a function that gets applied to an <var>Arraylist</var> item). The sort criteria pairs are passed to <var>SortNew</var> as a <var>[[SortOrder class\|SortOrder]]</var> argument.
	<p>~~The~~ sort key function that ~~gets~~ applied to ~~each~~ <var>Arraylist</var> ~~item, which you identify in the <var>SortNew</var> parameter,~~ must operate on the item type and return a <var>[[Intrinsic classes\|intrinsic]]</var> datatype (<var>Float</var>, <var>String</var>, <var>Longstring</var>, or <var>Unicode</var>) value. The values returned by the function are sorted into ascending or descending order to determine the position of their associated item in the new <var>Arraylist</var>.</p>		<p>Each sort key function (that is applied to the <var>Arraylist</var> items) must operate on the item type and return an <var>[[Intrinsic classes\|intrinsic]]</var> datatype (<var>Float</var>, <var>String</var>, <var>Longstring</var>, or <var>Unicode</var>) value. The values returned by the function are sorted into ascending or descending order to determine the position of their associated item in the new <var>Arraylist</var>.</p>

	==Syntax==		==Syntax==
Line 13:		Line 13:
	<td>The input <var>Arraylist</var> object.</td></tr>		<td>The input <var>Arraylist</var> object.</td></tr>
	<tr><th>sortOrder</th>		<tr><th>sortOrder</th>
	<td>~~One or more~~ <var>SortOrder</var> ~~objects~~, which ~~consist~~ of an ordering direction for the sort and a ~~key to~~ sort ~~by, specified in the form: <var class="term">order(~~key~~)</var>. The <var class="term">order</var> is either <code>Ascending</code> or <code>Descending</code>, and the <var class="term">key</var> is a~~ function ~~that is applied to each item in the <var>al</var>~~. For example:		<td>A <var>SortOrder</var> object, which consists of one or more pairs of an ordering direction for the sort and a sort key function. For example:
	<p class="code">%alist = %alist:sortnew(descending(length))		<p class="code">%alist = %alist:sortnew(descending(length))
	</p>		</p>
	The function is a method value (a method or class member name literal, or a method variable) for a method that operates on objects of the type specified on the <var class="term">al</var> declaration and that returns a numeric or string value. This is described further in [[SortOrder class#Specifying a SortOrder's sort key method\|"Specifying a SortOrder's sort key method"]].</td></tr>		The function is a method value (a method or class member name literal, or a method variable) for a method that operates on objects of the type specified on the <var class="term">al</var> declaration and that returns a numeric or string value. This is described further in [[SortOrder class#Specifying a SortOrder's sort key method\|"Specifying a SortOrder's sort key method"]].

			A <var>SortOrder</var> with multiple sort criteria can be specified using the <var>[[List (SortOrder function)\|List]]</var> function.
			</td></tr>
	</table>		</table>

Line 24:		Line 27:
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.
	<li>The function in the parameter for <var>SortNew</var> is a method value, not a User Language expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a User Language expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.
	<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var>~~sortCriteria~~</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var class="term">sortOrder</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.
	<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.		<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
	</ul>		</ul>

JALWiccan: 1 revision

2011-05-04T17:45:56Z

1 revision

← Older revision	Revision as of 17:45, 4 May 2011
(No difference)

Dme at 17:45, 4 May 2011

2011-05-04T17:45:54Z

← Older revision		Revision as of 17:45, 4 May 2011
Line 24:		Line 24:
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.		<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>sortNew</var> returns them in the same order in which they appear in the input <var class="term">al</var>.
	<li>The function in the parameter for <var>SortNew</var> is a method value, not a User Language expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.		<li>The function in the parameter for <var>SortNew</var> is a method value, not a User Language expression. That is, you cannot provide a function that, itself, also has an argument (say, <code>Char(13)</code>) as the <var>SortNew</var> parameter.
	<li>As of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6, the default <var>sortCriteria</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6, the default <var>sortCriteria</var> argument is the <var>SortOrder</var> <code>Ascending(This)</code>, where <var>This</var> is the identity function value described further in [[Collections#Using the This function as the Maximum parameter\|"Using the This function as the Maximum parameter"]]. Therefore, <code><var class="term">al</var>:sortnew(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sortnew</code>, as shown in the [[#Examples\|example]] below.
	<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.3 and later.		<li><var>SortNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
	</ul>		</ul>