Collections - Revision history

Alan: /* Coding considerations for collections */

2015-08-26T21:01:10Z

Coding considerations for collections

← Older revision		Revision as of 21:01, 26 August 2015
Line 89:		Line 89:
	==Coding considerations for collections==		==Coding considerations for collections==
	Although collections vary by collection type, they are more alike than they are different.		Although collections vary by collection type, they are more alike than they are different.
	~~This~~ remainder of this article contains topics that address features and methods common to all		The remainder of this article contains topics that address features and methods common to all
	the collection types.		the collection types.
	The characteristics and methods of each individual collection type are described in		The characteristics and methods of each individual collection type are described in

JAL: minor cleanup

2015-03-27T20:18:04Z

minor cleanup

← Older revision		Revision as of 20:18, 27 March 2015
Line 429:		Line 429:

	The <var>Print</var> result shows the encoded form of the Unicode item name:		The <var>Print</var> result shows the encoded form of the Unicode item name:
	<p class="~~code~~">1: &#x03C0;: 3.1415926		<p class="output">1: &#x03C0;: 3.1415926
	</p>		</p>

Line 436:		Line 436:
	If you specified <code>%transcendental:print(namewidth=4)</code>, for example,		If you specified <code>%transcendental:print(namewidth=4)</code>, for example,
	the item name '''is''' truncated:</p>		the item name '''is''' truncated:</p>
	<p class="~~code~~">1: &#x: 3.1415926 </p>		<p class="output">1: &#x: 3.1415926 </p>
	</blockquote>		</blockquote>

Line 489:		Line 489:

	The result is:		The result is:
	<p class="~~code~~">The longest list is item 3		<p class="output">The longest list is item 3
	</p>		</p>

Line 540:		Line 540:

	The result is:		The result is:
	<p class="~~code~~">Item 2 has eldest Python		<p class="output">Item 2 has eldest Python
	</p>		</p>

Line 617:		Line 617:
	</p>		</p>

	This request prints the number of the item that has the rightmost character that is alphabetically the		This request prints the number of the item that has the rightmost character that is alphabetically the earliest, then the number of the item that has the leftmost character that is
	earliest, then the number of the item that has the leftmost character that is
	the earliest (and closer to the beginning of the list):		the earliest (and closer to the beginning of the list):
	<p class="output">3		<p class="output">3
Line 800:		Line 799:
	The value that results from applying the <var>Absolute</var> method above is compared to		The value that results from applying the <var>Absolute</var> method above is compared to
	the second <var>Ge</var> parameter, 1000.		the second <var>Ge</var> parameter, 1000.
	This 1000 may be any <var class="product">SOUL</var> intrinsic expression, such as a string or numeric		This 1000 may be any <var class="product">SOUL</var> intrinsic expression, such as a string or numeric literal.
	literal.

	In the fragment that follows, the function in the <var>SelectionCriterion</var> is a local method,		In the fragment that follows, the function in the <var>SelectionCriterion</var> is a local method, and the searching method, <var>FindPreviousItemNumber</var>, searches
	and the searching method, <var>FindPreviousItemNumber</var>, searches
	backward starting with the tenth item in the collection to find the item		backward starting with the tenth item in the collection to find the item
	number of the first item that satisfies the criterion:		number of the first item that satisfies the criterion:
Line 818:		Line 815:
	</p>		</p>

	The local method <code>myMod</code> above, which calls the <var>[[Mod (Float function)\|Mod]]</var> method,		The local method <code>myMod</code> above, which calls the <var>[[Mod (Float function)\|Mod]]</var> method, is necessary in this case because the <var>SelectionCriterion</var>
	is necessary in this case because the <var>SelectionCriterion</var>
	function parameter may not itself specify a parameter.		function parameter may not itself specify a parameter.
	The function parameter is a method value, not a <var class="product">SOUL</var> expression.		The function parameter is a method value, not a <var class="product">SOUL</var> expression.
Line 827:		Line 823:
	as described in [[SelectionCriterion class#Declaring a SelectionCriterion object variable\|Declaring a SelectionCriterion object variable]].		as described in [[SelectionCriterion class#Declaring a SelectionCriterion object variable\|Declaring a SelectionCriterion object variable]].

	In the following example, the function parameter is the very useful identity function, <var>This</var>,		In the following example, the function parameter is the very useful identity function, <var>This</var>, which returns the value of the item to which it is applied.
	which returns the value of the item to which it is applied.
	The searching method <var>SubsetNew</var> returns a collection of all		The searching method <var>SubsetNew</var> returns a collection of all
	the items in the collection that satisfy either of the criteria		the items in the collection that satisfy either of the criteria
Line 844:		Line 839:
	comparable operations on <var>Stringlists</var>.		comparable operations on <var>Stringlists</var>.
	<p>		<p>
	For example, a level of indirection between object references and objects makes the processing much		For example, a level of indirection between object references and objects makes the processing much more complicated than that for <var>Stringlists</var>.
	more complicated than that for <var>Stringlists</var>.		However, because the cost of locates or subsets is likely to be a small fraction of the cost of most applications, switching to objects for these applications offers the benefits
	However, because the cost of
	locates or subsets is likely to be a small fraction of the cost of most
	applications, switching to objects for these applications offers the benefits
	of cleaner code without a major expense.</p></li>		of cleaner code without a major expense.</p></li>

Line 907:		Line 899:
	</tr>		</tr>
	</table>		</table>

	[[Category:Overviews]]		[[Category:Overviews]]
	[[Category:System classes]]		[[Category:System classes]]
	[[Category:SOUL object-oriented programming topics]]		[[Category:SOUL object-oriented programming topics]]

JAL: minor cleanup

2014-11-11T22:25:53Z

minor cleanup

← Older revision		Revision as of 22:25, 11 November 2014
Line 334:		Line 334:
	You can define a local function to display your output:		You can define a local function to display your output:
	<p class="code">local function (string):quote is longstring		<p class="code">local function (string):quote is longstring
	return ~~''''~~ with %this with ~~''''~~		return '''' with %this with ''''
	end function		end function
	</p>		</p>
Line 432:		Line 432:
	</p>		</p>

	<blockquote class="note"><b>Note:</b>		<blockquote class="note">
			<p><b>Note:</b>
	If you specified <code>%transcendental:print(namewidth=4)</code>, for example,		If you specified <code>%transcendental:print(namewidth=4)</code>, for example,
	the item name '''is''' truncated:		the item name '''is''' truncated:</p>
	<p class="code">1: &#x: 3.1415926 </p>		<p class="code">1: &#x: 3.1415926 </p>
	</blockquote>		</blockquote>
Line 587:		Line 588:

	<p class="note"><b>Note:</b>		<p class="note"><b>Note:</b>
	Of the collection classes, only the <var>Arraylist</var> class contains a <var>Sort</var> subroutine; all the collection classes have a <var>SortNew</var> function.		Of the collection classes, only the <var>Arraylist</var> class contains a <var>Sort</var> subroutine; all the collection classes have a <var>SortNew</var> function. </p>

	===Finding minima using a method variable parameter===		===Finding minima using a method variable parameter===
Line 607:		Line 608:
	%l is arraylist of string len 30		%l is arraylist of string len 30

	%l = list('Hickory, 'Dickory', 'Doc')		%l = list('Hickory', 'Dickory', 'Doc')
	%meth = rightmost		%meth = rightmost
	print %l:minimum(%meth)		print %l:minimum(%meth)
Line 623:		Line 624:
	</p>		</p>

	<blockquote class="note"><b>Note:</b>		<blockquote class="note">
			<p><b>Note:</b>
	Specifying the local functions themselves as the <var>Minimum</var>		Specifying the local functions themselves as the <var>Minimum</var>
	method parameter in the preceding example would also produce the same result.		method parameter in the preceding example would also produce the same result.
	For example, the first <code>print %l:minimum(%meth)</code> call in the example		For example, the first <code>print %l:minimum(%meth)</code> call in the example
	is equivalent to <code>print %l:minimum(rightmost)</code>.		is equivalent to <code>print %l:minimum(rightmost)</code>. </p>
	<p>		<p>
	However, explicitly specifying <code>right(1)</code>		However, explicitly specifying <code>right(1)</code>
Line 636:		Line 638:
	The parameter for <var>Minimum</var> is a method value, not a <var class="product">SOUL</var> expression.		The parameter for <var>Minimum</var> is a method value, not a <var class="product">SOUL</var> expression.
	You can use a local function as the <var>Minimum</var> parameter, as in the example above,		You can use a local function as the <var>Minimum</var> parameter, as in the example above,
	to apply a method that requires an argument. </p></blockquote>		to apply a method that requires an argument. </p>
			</blockquote>

	===Using the This function as the Maximum parameter===		===Using the This function as the Maximum parameter===
Line 822:		Line 825:
	The preceding example also shows a <var>SelectionCriterion</var> object declaration,		The preceding example also shows a <var>SelectionCriterion</var> object declaration,
	which must suit the item type to which the criterion will be applied,		which must suit the item type to which the criterion will be applied,
	as described in [[SelectionCriterion class#Declaring a SelectionCriterion object variable\|"Declaring a SelectionCriterion object variable"]].		as described in [[SelectionCriterion class#Declaring a SelectionCriterion object variable\|Declaring a SelectionCriterion object variable]].

	In the following example, the function parameter is the very useful identity function, <var>This</var>,		In the following example, the function parameter is the very useful identity function, <var>This</var>,
Line 846:		Line 849:
	locates or subsets is likely to be a small fraction of the cost of most		locates or subsets is likely to be a small fraction of the cost of most
	applications, switching to objects for these applications offers the benefits		applications, switching to objects for these applications offers the benefits
	of cleaner code without a major expense.</p>		of cleaner code without a major expense.</p></li>

	<li>The <var>FindNextItem</var> and <var>FindPreviousItem</var> methods throw an		<li>The <var>FindNextItem</var> and <var>FindPreviousItem</var> methods throw an
Line 855:		Line 858:
	<ul>		<ul>
	<li>For simply checking if an item in a collection matches a		<li>For simply checking if an item in a collection matches a
	<var>SelectionCriterion</var>, use <var>FindNextItemNumber</var> or <var>FindPreviousItemNumber</var>.		<var>SelectionCriterion</var>, use <var>FindNextItemNumber</var> or <var>FindPreviousItemNumber</var>.</li>

	<li>For looping over a collection, use <var>FindNextItemNumber</var> or <var>FindPreviousItemNumber</var>		<li>For looping over a collection, use <var>FindNextItemNumber</var> or <var>FindPreviousItemNumber</var>
	with an <var>If</var> test.		with an <var>If</var> test.</li>

	<li>For extracting a single item that you are very sure must be in the		<li>For extracting a single item that you are very sure must be in the
	collection, use <var>FindNextItem</var> or <var>FindPreviousItem</var>.		collection, use <var>FindNextItem</var> or <var>FindPreviousItem</var>.
	If you are wrong about the presence of the item,		If you are wrong about the presence of the item,
	the exception is thrown and the request is cancelled.		the exception is thrown and the request is cancelled.</li>

	<li>For conditionally extracting a single item from a collection, use		<li>For conditionally extracting a single item from a collection, use
	<var>FindNextItem</var> or <var>FindPreviousItem</var> with a <var>Try</var>/<var>Catch</var> clause.		<var>FindNextItem</var> or <var>FindPreviousItem</var> with a <var>Try</var>/<var>Catch</var> clause.</li>
	</ul>		</ul>
	<p>		<p>
Line 874:		Line 877:
	if there is an exception.		if there is an exception.
	<var>Try</var>/<var>Catch</var> therefore executes no code other than what you are		<var>Try</var>/<var>Catch</var> therefore executes no code other than what you are
	trying, whereas <var>If</var> has to also to execute the conditional test.</p>		trying, whereas <var>If</var> has to also to execute the conditional test.</p></li>
	</ul>		</ul>

JAL at 00:20, 18 October 2013

2013-10-18T00:20:55Z

Show changes

JAL: /* See also */

2013-10-14T22:13:04Z

JAL at 19:49, 14 October 2013

2013-10-14T19:49:54Z

← Older revision		Revision as of 19:49, 14 October 2013
Line 910:		Line 910:
	[[Category:Overviews]]		[[Category:Overviews]]
	[[Category:System classes]]		[[Category:System classes]]
	[[Category:~~Janus SOAP ULI~~ topics]]		[[Category:SOUL object-oriented programming topics]]

JAL: /* Operating on collection items */

2013-09-04T21:58:21Z

Operating on collection items

← Older revision		Revision as of 21:58, 4 September 2013
Line 101:		Line 101:
	==Operating on collection items==		==Operating on collection items==
	All collections have at least the two standard properties described below.		All collections have at least the two standard properties described below.
	<table>		<table class="thJustBold">
	<tr><th>Count</th>		<tr><th>Count</th>
	<td>Number of items in collection.</td></tr>		<td>Number of items in collection.</td></tr>

JAL at 21:42, 1 July 2013

2013-07-01T21:42:51Z

← Older revision		Revision as of 21:42, 1 July 2013
Line 41:		Line 41:

	<p class="note"><b>Note:</b>		<p class="note"><b>Note:</b>
	The <~~var~~>Collection</~~var~~> keyword is required before <var class="product">Sirius Mods</var> version 6.8.		The <code>Collection</code> keyword is required before <var class="product">Sirius Mods</var> version 6.8. </p>

	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>variable</th>		<tr><th>variable</th>
Line 80:		Line 81:
	CCATEMP.		CCATEMP.
	For this reason, consecutive references to the same collection item		For this reason, consecutive references to the same collection item
	are quite efficient.		are quite efficient. </p>

	Here are sample collection object declarations:		Here are sample collection object declarations:
Line 207:		Line 208:
	of an <code>arraylist of longstring</code> to an <code>arraylist of float</code>.		of an <code>arraylist of longstring</code> to an <code>arraylist of float</code>.

	<p class="note"><b>Note:</b>		<blockquote class="note"><b>Note:</b>
	When assigning to a collection variable and using the syntax of the <var>New</var> function that explicitly indicates the		When assigning to a collection variable and using the syntax of the <var>New</var> function that explicitly indicates the
	class for collections, both the collection and item datatypes must be		class for collections, both the collection and item datatypes must be
	specified just as on the collection variable declaration:		specified just as on the collection variable declaration:
	~~</p>~~
	<p class="code">%alist is collection floatNamedArraylist of longstring		<p class="code">%alist is collection floatNamedArraylist of longstring
	%alist = %(floatNamedArraylist of longstring):new		%alist = %(floatNamedArraylist of longstring):new
	</p>		</p> </blockquote>

	==Printing a collection==		==Printing a collection==
Line 269:		Line 269:
	</ul>		</ul>

	<p class="note"><b>Note:</b>		<blockquote class="note"><b>Note:</b>
	The <var>Print</var> method applies a <var>ToString</var> method (by default) to each item value		The <var>Print</var> method applies a <var>ToString</var> method (by default) to each item value
	(and always to each item name), to produce its result.		(and always to each item name), to produce its result.
Line 278:		Line 278:
	<li>The <var>Print</var> method includes an appropriate "method parameter,"		<li>The <var>Print</var> method includes an appropriate "method parameter,"
	as described below.		as described below.
	</ul>		</ul></blockquote>

	===General syntax of Print (Audit or Trace) for a collection===		===General syntax of Print (Audit or Trace) for a collection===
Line 436:		Line 436:
	</p>		</p>

	<p class="note"><b>Note:</b>		<blockquote class="note"><b>Note:</b>
	If you specified <code>%transcendental:print(namewidth=4)</code>, for example,		If you specified <code>%transcendental:print(namewidth=4)</code>, for example,
	the item name '''is''' truncated:		the item name '''is''' truncated:
	<p class="code">1: &#x: 3.1415926		<p class="code">1: &#x: 3.1415926 </p>
	</p>		</blockquote>

	==Finding collection maxima and minima, and sorting==		==Finding collection maxima and minima, and sorting==
Line 627:		Line 627:
	</p>		</p>

	<p class="note"><b>Note:</b>		<blockquote class="note"><b>Note:</b>
	Specifying the local functions themselves as the <var>Minimum</var>		Specifying the local functions themselves as the <var>Minimum</var>
	method parameter in the preceding example would also produce the same result.		method parameter in the preceding example would also produce the same result.
	For example, the first <code>print %l:minimum(%meth)</code> call in the example		For example, the first <code>print %l:minimum(%meth)</code> call in the example
	is equivalent to <code>print %l:minimum(rightmost)</code>.		is equivalent to <code>print %l:minimum(rightmost)</code>.
			<p>
	However, explicitly specifying <code>right(1)</code>		However, explicitly specifying <code>right(1)</code>
	(the method and argument that local function <code>rightmost</code> invokes)		(the method and argument that local function <code>rightmost</code> invokes)
Line 640:		Line 640:
	The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.		The parameter for <var>Minimum</var> is a method value, not a <var class="product">User Language</var> expression.
	You can use a local function as the <var>Minimum</var> parameter, as in the example above,		You can use a local function as the <var>Minimum</var> parameter, as in the example above,
	to apply a method that requires an argument.		to apply a method that requires an argument. </p></blockquote>

	===Using the This function as the Maximum parameter===		===Using the This function as the Maximum parameter===

JAL: /* Operating on collection items */

2013-06-26T19:43:57Z

Operating on collection items

← Older revision		Revision as of 19:43, 26 June 2013
Line 186:		Line 186:
	In the example above, as is usual with longstrings, a truncation		In the example above, as is usual with longstrings, a truncation
	of the longstring on addition would cause a request cancellation error.		of the longstring on addition would cause a request cancellation error.
			</p>

	==Comparing and assigning new collection variables==		==Comparing and assigning new collection variables==

JALWiccan: Automatically generated page update

2013-06-26T19:42:52Z

Automatically generated page update

← Older revision		Revision as of 19:42, 26 June 2013
Line 183:		Line 183:
	</p>		</p>

	~~'''~~Note:~~'''~~ In the example above, as is usual with longstrings, a truncation		<p class="note"><b>Note:</b>
			In the example above, as is usual with longstrings, a truncation
	of the longstring on addition would cause a request cancellation error.		of the longstring on addition would cause a request cancellation error.

← Older revision		Revision as of 22:13, 14 October 2013
Line 884:		Line 884:
	<ul>		<ul>
	<li>[[Method variables]]		<li>[[Method variables]]
	<li>[[~~Janus SOAP ULI essentials~~]]		<li>[[Object oriented programming in SOUL]]
	</ul>		</ul>
	<table class="list"><tr>		<table class="list"><tr>