FindPreviousItemNumber (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 20: Line 20:
<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>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 > -11</code>, where <code>this</code> is an identity function that simply returns the item's value. The item number of the first item tested by <var>FindPreviousItemNumber</var> that satisfies this expression is the method's return value.
For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <code>this</code> is an identity function that simply returns the item's value. The item number of the first item tested by <var>FindPreviousItemNumber</var> 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 ''<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 class="code">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>Start</th>
<tr><th>Start</th>
<td>The number of the item ''before'' which to begin the search. If the ''itemnum'' value of Start is 4, item 3 is the first item considered. The value of Start may be 1 through one plus the number of items in the <var>Arraylist</var>. For a collection of three items, ''itemnum'' may be 1, 2, 3, or 4.
<td>The number of the item ''before'' which to begin the search. If the ''itemnum'' value of Start is 4, item 3 is the first item considered. The value of Start may be 1 through one plus the number of items in the <var>Arraylist</var>. For a collection of three items, ''itemnum'' may be 1, 2, 3, or 4.
This is an optional argument, and it defaults to one plus the number of items in the collection. If you specify a value, the parameter name <var>Start</var> is required.</td></tr>
<p class="code">This is an optional argument, and it defaults to one plus the number of items in the collection. If you specify a value, the parameter name <var>Start</var> is required.</td></tr>
</p>
</table>
</table>


Line 40: Line 42:
an <var>Arraylist</var> of strings, starts checking the last item first, by default;
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 second call, for an <var>Arraylist</var> of float, uses a compound criterion:
<pre style="xmp">
<p class="code">Begin
    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, 'boston')
%sel = LT(this, 'boston')
    %sel2 = OR(GT(this, 100), LT(this, 0))
%sel2 = OR(GT(this, 100), LT(this, 0))


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


The result is:
The result is:
<pre style="xmp">
<p class="output">%al:findPreviousItemNumber(%sel) is: 4
    %al:findPreviousItemNumber(%sel) is: 4
%al2:findPreviousItemNumber(%sel2, start=6) is: 1
    %al2:findPreviousItemNumber(%sel2, start=6) is: 1
</p>
</pre>
==See also==
==See also==
{{Template:Arraylist:FindPreviousItemNumber footer}}
{{Template:Arraylist:FindPreviousItemNumber footer}}

Revision as of 20:55, 28 January 2011

Return number of matching item (Arraylist class)


This function searches "backward" 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 FindPreviousItemNumber parameter. If no item satisfies the criterion, the method returns a zero.

FindPreviousItemNumber is available in Sirius Mods version 7.6 and later.

Syntax

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

Syntax terms

%itemnum A numeric variable to contain the item number of the item that is located by the search.
al An Arraylist object.
criterion 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 item number of the first item tested by FindPreviousItemNumber 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.

Start The number of the item before which to begin the search. If the itemnum value of Start is 4, item 3 is the first item considered. The value of Start may be 1 through one plus the number of items in the Arraylist. For a collection of three items, itemnum may be 1, 2, 3, or 4.

This is an optional argument, and it defaults to one plus the number of items in the collection. If you specify a value, the parameter name Start is required.

Usage notes

  • If the value of Start is not in the range of 2 through one plus the number of items in the Arraylist, the request is cancelled. If the value of Start is 1, no item can be found and the method returns a zero.
  • FindNextItemNumber is identical to FindPreviousItemNumber except that it searches forward in the Arraylist.

Examples

The following request contains two FindPreviousItemNumber calls: the first, for an Arraylist of strings, starts checking the last item first, by default; the second call, for an Arraylist of float, uses a compound criterion:

Begin %al is arraylist of string len 10 %al2 is arraylist of float %al = list('boston', 'belmont', 'brighton', - 'bedford', 'boxford') %al2 = list(111, 29, 0, 93, 77, -345) %sel is object selectioncriterion for string len 10 %sel2 is object selectioncriterion for float %sel = LT(this, 'boston') %sel2 = OR(GT(this, 100), LT(this, 0)) printtext {~} is: {%al:findPreviousItemNumber(%sel)} printtext {~} is: {%al2:findPreviousItemNumber(%sel2, start=6)} End

The result is:

%al:findPreviousItemNumber(%sel) is: 4 %al2:findPreviousItemNumber(%sel2, start=6) is: 1

See also