FindNextItemNumber (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax diagram to template and fix tags)
Line 1: Line 1:
{{Template:Arraylist:FindNextItemNumber subtitle}}
{{Template:Arraylist:FindNextItemNumber subtitle}}


This function searches "forward" in the <var>Arraylist</var> to find and return
This function searches "forward" in the <var>Arraylist</var> to find and return the item number of the next item that matches a specified criterion. The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object that is a required <var>FindNextItemNumber</var> parameter. If no item satisfies the criterion, the method returns a zero.
the item number of the next item that matches a specified criterion.
The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object
that is a required <var>FindNextItemNumber</var> parameter.
If no item satisfies the criterion, the method returns a zero.


<var>FindNextItemNumber</var> is available in ''Sirius Mods'' version 7.6 and later.
==Syntax==
==Syntax==
{{Template:Arraylist:FindNextItemNumber syntax}}
{{Template:Arraylist:FindNextItemNumber syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%itemnum</i></th>
<tr><th><i>%number</i></th>
<td>A numeric variable to contain the item number of the item that is located by the search. </td></tr>
<td>A numeric variable to return the item number of the item that is located by the search. </td></tr>
<tr><th><i><var class="term">al</var></i></th>
<tr><th><i>al</i></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>criterion</i></th>
<tr><th><i>selectionCriterion</i></th>
<td>A <var>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.
<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. For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <code>this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItem</var> that satisfies this expression is the method's return value.<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>
<p class="code">For example, <tt>GT(this, -11)</tt> is the criterion <tt>this</tt> <tt>></tt> <tt>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The item number of the first item tested by <var>FindNextItemNumber</var> that satisfies this expression is the method's return value.
<tr><th><b>Start</b></th><td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of Start 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 collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.<p>This is an optional argument, and it defaults to 0. If you specify a value, the parameter name <var class="term">Start</var> is required.</p></td></tr>
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]]". </td></tr>
</p>
<tr><th><b>Start=</b><i> itemnum</i></th>
<td>The number of the item ''after'' which to begin the search. If the ''itemnum'' value of Start is 2, item 3 is the first item considered. The value of Start may be 0 through the number of items in the collection. For a collection of three items, ''itemnum'' may be 0, 1, 2, or 3.
<p class="code">This is an optional argument, and it defaults to 0. If you specify a value, the parameter name <tt>Start</tt> is required.</td></tr>
</p>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>If the value of Start is greater than the number of items in the <var>Arraylist</var>,
<li>If the value of <var>start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var>start</var> is equal to the number of items, <var>FindNextItemNumber</var> returns a zero.
the request is cancelled.
<li>[[FindPreviousItemNumber (Arraylist function)|FindPreviousItemNumber]] is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.
If the value of Start is equal to the number of items, <var>FindNextItemNumber</var>
<li><var>FindNextItemNumber</var> is available in <var classs="product">Sirius Mods</var> version 7.6 and later.
returns a zero.
<li>[[FindPreviousItemNumber (Arraylist function)|FindPreviousItemNumber]] is identical
to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.
</ul>
</ul>
==Examples==
==Examples==
<ol><li>
The following request contains two <var>FindNextItemNumber</var> calls, one with a simple selection criterion and one with a compound criterion:
<p class="code">begin
  %al is  arraylist of float
  %al = list(111, 29, 0, 93, 77, -345)


The following request contains two <var>FindNextItemNumber</var> calls, one with a simple
  %sel1 is object selectioncriterion for float
selection criterion and one with a compound criterion:
  %sel2 is object selectioncriterion for float
<p class="code">Begin
  %sel1 = GT(this, 100)
%al is arraylist of float
  %sel2 = AND(GE(this, 53), LT(this, 93))
%al = list(111, 29, 0, 93, 77, -345)


%sel1 is object selectioncriterion for float
  printtext {~} is: {%al:findNextItemNumber(%sel1, start=1)}
%sel2 is object selectioncriterion for float
  printtext {~} is: {%al:findNextItemNumber(%sel2)}
%sel1 = GT(this, 100)
end
%sel2 = AND(GE(this, 53), LT(this, 93))
 
printtext {~} is: {%al:findNextItemNumber(%sel1, start=1)}
printtext {~} is: {%al:findNextItemNumber(%sel2)}
End
</p>
</p>


Line 56: Line 43:
<p class="output">%al:findNextItemNumber(%sel1, start=1) is: 0
<p class="output">%al:findNextItemNumber(%sel1, start=1) is: 0
%al:findNextItemNumber(%sel2) is: 5
%al:findNextItemNumber(%sel2) is: 5
</p>
</p></ol>
 
==See also==
==See also==
{{Template:Arraylist:FindNextItemNumber footer}}
{{Template:Arraylist:FindNextItemNumber footer}}

Revision as of 23:44, 29 January 2011

Return number of matching item (Arraylist class)


This function searches "forward" in the Arraylist to find and return the item number of the next item that matches a specified criterion. The criterion is supplied by the SelectionCriterion object that is a required FindNextItemNumber parameter. If no item satisfies the criterion, the method returns a zero.

Syntax

%number = al:FindNextItemNumber( selectionCriterion, [Start= number])

Syntax terms

%number A numeric variable to return the item number of the item that is located by the search.
al An Arraylist object.
selectionCriterion A selectionCriterion object, which is a relational expression that is applied to an al item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value. For example, GT(this, -11) is the criterion this > -11, where this is an identity function that simply returns the item's value. The first item tested by FindNextItem that satisfies this expression is the method's return value.

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 al declaration and that returns a numeric or string value. This is described further in Specifying a SelectionCriterion's parameters.

StartThe number of the item after which to begin the search. If the number value of Start is 2, item 3 is the first item considered. The value of Start may be 0 through the number of items in the collection. For a collection of three items, number may be 0, 1, 2, or 3.

This is an optional argument, and it defaults to 0. If you specify a value, the parameter name Start is required.

Usage notes

  • If the value of start is greater than the number of items in the Arraylist, the request is cancelled. If the value of start is equal to the number of items, FindNextItemNumber returns a zero.
  • FindPreviousItemNumber is identical to FindNextItemNumber except that it searches backward in the Arraylist.
  • FindNextItemNumber is available in Sirius Mods version 7.6 and later.

Examples

  1. The following request contains two FindNextItemNumber calls, one with a simple selection criterion and one with a compound criterion:

    begin %al is arraylist of float %al = list(111, 29, 0, 93, 77, -345) %sel1 is object selectioncriterion for float %sel2 is object selectioncriterion for float %sel1 = GT(this, 100) %sel2 = AND(GE(this, 53), LT(this, 93)) printtext {~} is: {%al:findNextItemNumber(%sel1, start=1)} printtext {~} is: {%al:findNextItemNumber(%sel2)} end

    The result is:

    %al:findNextItemNumber(%sel1, start=1) is: 0 %al:findNextItemNumber(%sel2) is: 5

See also