Sort (Arraylist subroutine) - Revision history

JAL2: /* Usage notes */

2012-08-13T19:37:07Z

Usage notes

← Older revision		Revision as of 19:37, 13 August 2012
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>Sort</var> returns <var>String</var> or <var>Unicode</var> values, <var>Sort</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~~</var>~~ returns a numeric type, numeric comparisons are used.		<li>If the function applied by <var>Sort</var> returns <var>String</var> or <var>Unicode</var> values, <var>Sort</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>Sort</var> places 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>Sort</var> places them in the same order in which they appear in the input <var class="term">al</var>.

JAL2: /* Usage notes */

2012-08-13T19:36:00Z

Usage notes

← Older revision		Revision as of 19:36, 13 August 2012
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>Sort</var> returns <var>String</var> or <var>Unicode</var> values, <var>Sort</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>Sort</var> returns <var>String</var> or <var>Unicode</var> values, <var>Sort</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</var> 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>Sort</var> places 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>Sort</var> places them in the same order in which they appear in the input <var class="term">al</var>.

JAL2: /* Usage notes */

2012-08-09T23:16:02Z

Usage notes

← Older revision		Revision as of 23:16, 9 August 2012
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>Sort</var> returns ~~string~~ values, <var>Sort</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>Sort</var> returns <var>String</var> or <var>Unicode</var> values, <var>Sort</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>Sort</var> places 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>Sort</var> places 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>Sort</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 (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.		<li>The function in the parameter for <var>Sort</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 (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].		<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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].
	<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
			<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
	</ul>		</ul>

JAL2: /* Usage notes */

2012-03-19T18:52:55Z

Usage notes

← Older revision		Revision as of 18:52, 19 March 2012
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the function applied by <var>Sort</var> returns string values, <var>Sort</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>Sort</var> returns string values, <var>Sort</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>Sort</var> places 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>Sort</var> places 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>Sort</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 (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.		<li>The function in the parameter for <var>Sort</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 (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.
Line 24:		Line 24:
	<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.		<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
	</ul>		</ul>

	==Examples==		==Examples==
	For examples of the <var>Sort</var> method, see [[Collections#Finding collection maxima and minima, and sorting\|"Finding collection maxima and minima, and sorting"]].		For examples of the <var>Sort</var> method, see [[Collections#Finding collection maxima and minima, and sorting\|"Finding collection maxima and minima, and sorting"]].

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 20:		Line 20:
	<li>If the function applied by <var>Sort</var> returns string values, <var>Sort</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>Sort</var> returns string values, <var>Sort</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>Sort</var> places 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>Sort</var> places 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>Sort</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.		<li>The function in the parameter for <var>Sort</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 (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].		<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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].
	<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.		<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.

JAL2 at 22:16, 30 November 2011

2011-11-30T22:16:30Z

← Older revision		Revision as of 22:16, 30 November 2011
Line 1:		Line 1:
	{{Template:Arraylist:Sort subtitle}}		{{Template:Arraylist:Sort subtitle}}
	<var>Sort</var> sorts the method object <var>Arraylist</var> replacing it with the sorted result. The sort is based on one or more ~~<var>[[SortOrder_class\|~~sort criteria~~]]</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>Sort</var> sorts the method object <var>Arraylist</var> replacing it with the sorted result. 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>Sort</var> parameter~~) must operate on the item type and return ~~a User Language~~ <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 <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 <var>Arraylist</var>.</p>

	==Syntax==		==Syntax==

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 20:		Line 20:
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>Sort</var> places 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>Sort</var> places 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>Sort</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.		<li>The function in the parameter for <var>Sort</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].		<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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].
	<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.3 and later.		<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.
	</ul>		</ul>

Dme at 17:48, 3 May 2011

2011-05-03T17:48:47Z

← Older revision		Revision as of 17:48, 3 May 2011
Line 20:		Line 20:
	<li>If two or more <var class="term">al</var> items have equal values after all sort criteria are applied, <var>Sort</var> places 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>Sort</var> places 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>Sort</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</var> parameter.		<li>The function in the parameter for <var>Sort</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code><var>[[ToIntegerPower and ToPower (Float functions)\|ToIntegerPower]]</var>(2)</code>) as the <var>Sort</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 <~~code~~>This</~~code~~> is the identity function 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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See [[SortNew (Arraylist function)#Examples\|"SortNew example"]].		<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>:sort(ascending(this))</code> can be specified simply as <code><var class="term">al</var>:sort</code>. See the [[SortNew (Arraylist function)#Examples\|"SortNew example"]].
	<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.3 and later.		<li><var>Sort</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.3 and later.
	</ul>		</ul>