FindNextItemNumber (GenericNamedArraylist function) - Revision history

JAL2 at 21:16, 7 August 2012

2012-08-07T21:16:16Z

← Older revision		Revision as of 21:16, 7 August 2012
Line 16:		Line 16:
	<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">anyNal</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>		<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">anyNal</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>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var ~~class="term"~~>Start</var> is 2, item 3 is the first item considered. The value of <var ~~class="term"~~>Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
	<p>This is an optional, [[Methods#Named parameters\|name required]], argument which defaults to 0. If you specify a value, the parameter name <var ~~class="term"~~>Start</var> is required.</p></td></tr>		<p>This is an optional, [[Methods#Named parameters\|name required]], argument which defaults to 0. If you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the value of <var ~~class="term"~~>Start</var> is greater than the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>, the request is cancelled. If the value of <var ~~class="term"~~>Start</var> is equal to the number of items, then <var>FindNextItemNumber</var> returns a zero.		<li>If the value of <var>Start</var> is greater than the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, then <var>FindNextItemNumber</var> returns a zero.
	<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.		<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
	</ul>		</ul>

JAL2: /* Examples */

2012-08-05T21:23:43Z

Examples

← Older revision		Revision as of 21:23, 5 August 2012
Line 60:		Line 60:
	<li>The following request contains two <var>FindNextItemNumber</var> calls and one		<li>The following request contains two <var>FindNextItemNumber</var> calls and one
	<var>FindPreviousItemNumber</var> call:		<var>FindPreviousItemNumber</var> call:
	<p class="code">		<p class="code">begin
	begin

	%k is unicodeNamedArraylist of longstring		%k is unicodeNamedArraylist of longstring
	%k = new		%k = new
	%k('&sect;Jan':u) = 'Orion'		%k('&sect;Jan':u) = 'Orion'
	%k('&sect;Apr':u) = 'Leo'		%k('&sect;Apr':u) = 'Leo'
	%k('&sect;Mar':u) = 'Cancer'		%k('&sect;Mar':u) = 'Cancer'
	%k('&sect;Jun':u) = 'Ursa Minor'		%k('&sect;Jun':u) = 'Ursa Minor'
	%k('&sect;Nov':u) = 'Andromeda'		%k('&sect;Nov':u) = 'Andromeda'
	%k('&sect;Dec':u) = 'Aries'		%k('&sect;Dec':u) = 'Aries'
	%k('&sect;Feb':u) = 'Canis Major'		%k('&sect;Feb':u) = 'Canis Major'

	%sel is object selectionCriterion for longstring		%sel is object selectionCriterion for longstring
	%n is float		%n is float
	%sel = LT(this, 'C')		%sel = LT(this, 'C')

	%n = %k:findNextitemNumber(%sel)		%n = %k:findNextitemNumber(%sel)
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

	%n = %k:findNextItemNumber(%sel, start=%n)		%n = %k:findNextItemNumber(%sel, start=%n)
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

	%n = %k:findPreviousItemNumber(EQ(this, 'Leo'), start=%n)		%n = %k:findPreviousItemNumber(EQ(this, 'Leo'), start=%n)
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

	end		end
	</p>		</p>

JAL2: /* Examples */

2012-08-05T21:21:21Z

Examples

← Older revision		Revision as of 21:21, 5 August 2012
Line 48:		Line 48:
	print %old:nameByNumber(%n)		print %old:nameByNumber(%n)

	%n = %old:findPreviousItemNumber(lt(name, 'Mud'), -		%n = %old:findPreviousItemNumber(lt(name, 'Mud'), start=%n)
	start=%n)
	print %old:nameByNumber(%n)		print %old:nameByNumber(%n)
	</p>		</p>
Line 91:		Line 90:

	The result is:		The result is:
	<p class="code">		<p class="code">§Dec
	§Dec		§Nov
	§Nov		§Apr
	§Apr
	</p>		</p>

Dme: /* Examples */

2012-08-05T19:41:01Z

Examples

← Older revision		Revision as of 19:41, 5 August 2012
Line 36:		Line 36:
	%old('Jon') = newf('White', 'retired')		%old('Jon') = newf('White', 'retired')

	%sel1 is object selectioncriterion for ~~float~~		%sel1 is object selectioncriterion for object staff
	%sel2 is object selectioncriterion for ~~float~~		%sel2 is object selectioncriterion for object staff
	%n is float		%n is float
	%sel1 = GT(name, 'Mud')		%sel1 = gt(name, 'Mud')
	%sel2 = ~~AND~~(GT(name, 'Mud'), EQ(status, 'retired'))		%sel2 = and(gt(name, 'Mud'), eq(status, 'retired'))

	%n = %old:~~FindNextItemNumber~~(%sel1, start=1)		%n = %old:findNextItemNumber(%sel1, start=1)
	~~Print~~ %old:nameByNumber(%n)		print %old:nameByNumber(%n)

	%n = %old:~~FindNextItemNumber~~(%sel2)		%n = %old:findNextItemNumber(%sel2)
	~~Print~~ %old:nameByNumber(%n)		print %old:nameByNumber(%n)

	%n = %old:~~FindPreviousItemNumber~~(LT(name, 'Mud'), -		%n = %old:findPreviousItemNumber(lt(name, 'Mud'), -
	start=%n)		start=%n)
	~~Print~~ %old:nameByNumber(%n)		print %old:nameByNumber(%n)
	</p>		</p>

Line 56:		Line 56:
	<p class="output">Jim		<p class="output">Jim
	Jon		Jon
	~~Jan~~		Jed
	</p>		</p>

	<li>The following request contains two FindNextItemNumber calls and one		<li>The following request contains two <var>FindNextItemNumber</var> calls and one
	FindPreviousItemNumber call:		<var>FindPreviousItemNumber</var> call:
	<p class="code">		<p class="code">
	begin		begin
Line 81:		Line 81:
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

	%n = %k:~~FindNextItemNumber~~(%sel, start=%n)		%n = %k:findNextItemNumber(%sel, start=%n)
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

	%n = %k:~~FindPreviousItemNumber~~(EQ(this, 'Leo'), start=%n)		%n = %k:findPreviousItemNumber(EQ(this, 'Leo'), start=%n)
	print %k:nameByNumber(%n)		print %k:nameByNumber(%n)

Dme: /* Examples */

2012-08-05T19:27:39Z

Examples

@@ Line 57: / Line 57: @@
 Jon
 Jan
-</p></ol>
+</p>
 ==See also==
 <ul><li><var>[[FindPreviousItemNumber_(GenericNamedArraylist_function)|FindPreviousItemNumber]]</var> is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>.</ul>
 {{Template:GenericNamedArraylist:FindNextItemNumber footer}}

JALWiccan: 1 revision

2012-06-10T22:20:59Z

1 revision

← Older revision	Revision as of 22:20, 10 June 2012
(No difference)

JAL2: /* Syntax terms */

2012-06-10T22:20:58Z

Syntax terms

← Older revision		Revision as of 22:20, 10 June 2012
Line 17:		Line 17:
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
	<p>This is an optional, ~~but~~ [[Methods#Named parameters\|name required]], argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>		<p>This is an optional, [[Methods#Named parameters\|name required]], argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-05-04T21:56:29Z

Syntax terms

← Older revision		Revision as of 21:56, 4 May 2011
Line 17:		Line 17:
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
	<p>This is an optional, but ~~<var>~~[[Methods#Named parameters\|name required]]~~</var>~~, argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>		<p>This is an optional, but [[Methods#Named parameters\|name required]], argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-05-04T19:37:34Z

1 revision

← Older revision	Revision as of 19:37, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T19:37:33Z

1 revision

← Older revision		Revision as of 19:37, 4 May 2011
Line 17:		Line 17:
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
	<p>This is an optional, but <var>[[Methods#Named parameters\|~~Name-Required~~]]</var>, argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>		<p>This is an optional, but <var>[[Methods#Named parameters\|name required]]</var>, argument which defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>
	</table>		</table>