FindPreviousItem (Arraylist function) - Revision history

JAL2: /* Syntax terms */

2012-08-09T23:23:09Z

Syntax terms

← Older revision		Revision as of 23:23, 9 August 2012
Line 8:		Line 8:
	<tr><th>%item</th>		<tr><th>%item</th>
	<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>		<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>

	<tr><th>al</th>		<tr><th>al</th>
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>
	<tr><th><var>Start</var></th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 4, item 3 is the first item considered. The value of <var>Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, ~~but <var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~, argument; if you specify a value, the parameter name <var>Start</var> is required.</p>		<tr><th>selectionCriterion</th>
			<td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
			<p>
			For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p>
			<p>
			The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]]. </p></td></tr>

			<tr><th><var>Start</var></th>
			<td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 4, item 3 is the first item considered. The value of <var>Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p>
			<p>
			This is an optional, [[Notation conventions for methods#Named parameters\|name required]], argument; if you specify a value, the parameter name <var>Start</var> is required.</p>
	</table>		</table>

JAL2: /* Examples */

2012-08-09T23:17:34Z

Examples

← Older revision		Revision as of 23:17, 9 August 2012
Line 20:		Line 20:

	==Examples==		==Examples==
	~~<ol><li>~~The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:		The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:
	<p class="code">begin		<p class="code">begin
	%al is arraylist of string len 10		%al is arraylist of string len 10
Line 42:		Line 42:
	%al2:findPreviousItem(%sel2, start=6) is: 111		%al2:findPreviousItem(%sel2, start=6) is: 111
	</p>		</p>
	~~</ol>~~

	==See also==		==See also==
	<ul><li><var>[[FindNextItem (Arraylist function)\|FindNextItem]]</var> is identical to <var>FindPreviousItem</var> except that it searches forward in the <var>Arraylist</var>.</ul>		<ul><li><var>[[FindNextItem (Arraylist function)\|FindNextItem]]</var> is identical to <var>FindPreviousItem</var> except that it searches forward in the <var>Arraylist</var>.</ul>
	{{Template:Arraylist:FindPreviousItem footer}}		{{Template:Arraylist:FindPreviousItem footer}}

JAL2 at 21:17, 7 August 2012

2012-08-07T21:17:10Z

← Older revision		Revision as of 21:17, 7 August 2012
Line 11:		Line 11:
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>		<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>
	<tr><th><var>Start</var></th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var ~~class="term"~~>Start</var> is 4, item 3 is the first item considered. The value of <var ~~class="term"~~>Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var ~~class="term"~~>Start</var> is required.</p>		<tr><th><var>Start</var></th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 4, item 3 is the first item considered. The value of <var>Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var>Start</var> is required.</p>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var ~~class="term"~~>Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<ul><li>If the value of <var>Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.
	<li><var>FindPreviousItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.		<li><var>FindPreviousItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
	</ul>		</ul>

JALWiccan: 1 revision

2011-05-04T17:45:55Z

1 revision

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

JAL2: /* Syntax terms */

2011-05-04T17:45:54Z

Syntax terms

← Older revision		Revision as of 17:45, 4 May 2011
Line 16:		Line 16:
	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var class="term">Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<ul><li>If the value of <var class="term">Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.
	<li><var>FindPreviousItem</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.		<li><var>FindPreviousItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
	</ul>		</ul>

JAL2: /* Syntax terms */

2011-04-12T23:48:47Z

Syntax terms

← Older revision		Revision as of 23:48, 12 April 2011
Line 11:		Line 11:
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>		<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>
	<tr><th>Start</th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var class="term">Start</var> is 4, item 3 is the first item considered. The value of <var class="term">Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.</p>		<tr><th><var>Start</var></th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var class="term">Start</var> is 4, item 3 is the first item considered. The value of <var class="term">Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.</p>
	</table>		</table>

Goff: what was I thiking with those blank lines

2011-03-11T06:52:49Z

what was I thiking with those blank lines

← Older revision		Revision as of 06:52, 11 March 2011
Line 1:		Line 1:
	{{Template:Arraylist:FindPreviousItem subtitle}}		{{Template:Arraylist:FindPreviousItem subtitle}}

	<var>FindPreviousItem</var> searches "backward" in the <var>Arraylist</var> to find and return the previous item that matches a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class\|SelectionCriterion]]</var> object that is a required <var>FindPreviousItem</var> parameter. If no item satisfies the criterion, the request is cancelled and an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<var>FindPreviousItem</var> searches "backward" in the <var>Arraylist</var> to find and return the previous item that matches a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class\|SelectionCriterion]]</var> object that is a required <var>FindPreviousItem</var> parameter. If no item satisfies the criterion, the request is cancelled and an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.

Line 17:		Line 16:
	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var class="term">Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<ul><li>If the value of <var class="term">Start</var> is not in the range of 1 through one plus the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.
	<li><var>FindPreviousItem</var> is available in <var class+"product">Sirius Mods</var> ~~version~~ 7.6 and later.		<li><var>FindPreviousItem</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.
	</ul>		</ul>

Line 23:		Line 22:
	<ol><li>The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:		<ol><li>The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:
	<p class="code">begin		<p class="code">begin
	%al is arraylist of string len 10		%al is arraylist of string len 10
	%al2 is arraylist of float		%al2 is arraylist of float
	%al = list('boston', 'belmont', 'brighton', -		%al = list('boston', 'belmont', 'brighton', -
	'bedford', 'boxford')		'bedford', 'boxford')
	%al2 = list(111, 29, 0, 93, 77, -345)		%al2 = list(111, 29, 0, 93, 77, -345)

	%sel is object selectioncriterion for string len 10		%sel is object selectioncriterion for string len 10
	%sel2 is object selectioncriterion for float		%sel2 is object selectioncriterion for float
	%sel = LT(this, 'bos')		%sel = LT(this, 'bos')
	%sel2 = OR(GT(this, 100), LT(this, 0))		%sel2 = OR(GT(this, 100), LT(this, 0))

	~~printtext~~ {~} is: {%al:findPreviousItem(%sel)}		[[PrintText statement\|printText]] {~} is: {%al:findPreviousItem(%sel)}
	printtext {~} is: {%al2:findPreviousItem(%sel2, start=6)}		printtext {~} is: {%al2:findPreviousItem(%sel2, start=6)}
	end		end
	</p>		</p>

Dme: /* Syntax terms */

2011-02-08T18:37:00Z

Syntax terms

← Older revision		Revision as of 18:37, 8 February 2011
Line 11:		Line 11:
	<tr><th>al</th>		<tr><th>al</th>
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>selectionCriterion</th><td>A <var ~~class="term"~~>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>		<tr><th>selectionCriterion</th><td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <var>this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p><p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items 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 [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]. </p></td></tr>
	<tr><th>Start</th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var class="term">Start</var> is 4, item 3 is the first item considered. The value of <var class="term">Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.</p>		<tr><th>Start</th><td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the <var class="term">number</var> value of <var class="term">Start</var> is 4, item 3 is the first item considered. The value of <var class="term">Start</var> may be 1 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4.<p>The default value for <var>Start</var> is the number of items in the collection plus one; to start from the last item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.</p>
	</table>		</table>

Wiccan: 1 revision

2011-02-07T23:00:07Z

1 revision

← Older revision	Revision as of 23:00, 7 February 2011
(No difference)

Wiccan: 1 revision

2011-02-07T23:00:06Z

1 revision

← Older revision		Revision as of 23:00, 7 February 2011
Line 23:		Line 23:
	<ol><li>The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:		<ol><li>The following request contains two <var>FindPreviousItem</var> calls: the first, for an <var>Arraylist</var> of strings, starts checking the last item first, by default; the second call, for an <var>Arraylist</var> of float, uses a compound criterion:
	<p class="code">begin		<p class="code">begin
	~~<p class="code">~~%al is arraylist of string len 10		%al is arraylist of string len 10
	%al2 is arraylist of float		%al2 is arraylist of float
	%al = list('boston', 'belmont', 'brighton', -		%al = list('boston', 'belmont', 'brighton', -
	'bedford', 'boxford')		'bedford', 'boxford')
	%al2 = list(111, 29, 0, 93, 77, -345)		%al2 = list(111, 29, 0, 93, 77, -345)

	%sel is object selectioncriterion for string len 10		%sel is object selectioncriterion for string len 10
	%sel2 is object selectioncriterion for float		%sel2 is object selectioncriterion for float
	%sel = LT(this, 'bos')		%sel = LT(this, 'bos')
	%sel2 = OR(GT(this, 100), LT(this, 0))		%sel2 = OR(GT(this, 100), LT(this, 0))

	printtext {~} is: {%al:findPreviousItem(%sel)}		printtext {~} is: {%al:findPreviousItem(%sel)}
	printtext {~} is: {%al2:findPreviousItem(%sel2, start=6)}		printtext {~} is: {%al2:findPreviousItem(%sel2, start=6)}
	~~</p>~~
	end		end
	</p>		</p>