FindPreviousItemNumber (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Examples) |
||
| (15 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:FindPreviousItemNumber subtitle}} | {{Template:GenericNamedArraylist:FindPreviousItemNumber subtitle}} | ||
<var>FindPreviousItemNumber</var> searches "backward" through the <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> to find and return the item number of the previous item that matches a specified criterion. The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object that is a required <var>FindPreviousItemNumber</var> parameter. If no item satisfies the criterion, the method returns a zero. | |||
the item number of the | |||
The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object | |||
that is a required FindPreviousItemNumber parameter. | |||
If no item satisfies the criterion, | |||
the method returns a zero. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:FindPreviousItemNumber syntax}} | {{Template:GenericNamedArraylist:FindPreviousItemNumber syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</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 contain the item number of the item that is located by the search. </td></tr> | ||
<tr><th> | <tr><th>anyNal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr> | ||
<tr><th> | <tr><th>selectionCriterion</th> | ||
<td>A SelectionCriterion object, which is a relational expression that is applied to a | <td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">anyNal</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>LT(this, 11)</code> is the criterion <code>this < 11</code>, where <var class="term">this</var> 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.</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">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> | |||
<td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the value of <var>Start</var> is 4, item 3 is the first item considered. The value of <var>Start</var> may be 1 through one plus the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>. For a collection of three items, <var class="term">number</var> may be 1, 2, 3, or 4. | |||
<p>This is an optional, [[Methods#Named parameters|name required]], argument which defaults to one plus the number of items in the NamedArraylist. If you specify a value, the parameter name <var>Start</var> is required.</p></td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the value of Start is not in the range of 2 through one plus the number | <li>If the value of <var>Start</var> is not in the range of 2 through one plus 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 1, no item can be found and the method returns a zero. | ||
of items in the NamedArraylist, the request is cancelled. | <li>FindPreviousItemNumber is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.6 and later. | ||
If the value of Start is 1, no item can be found and | |||
the method returns a zero. | |||
<li>[[ | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
See the <var>FindNextItemNumber</var> [[FindNextItemNumber_(GenericNamedArraylist_function)#Examples|"Examples"]] section. | |||
==See also== | ==See also== | ||
<ul><li><var>[[FindNextItemNumber_(GenericNamedArraylist_function)|FindNextItemNumber]]</var> is identical to <var>FindPreviousItemNumber</var> except that it searches forward in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>.</ul> | |||
{{Template:GenericNamedArraylist:FindPreviousItemNumber footer}} | {{Template:GenericNamedArraylist:FindPreviousItemNumber footer}} | ||
Latest revision as of 19:47, 1 November 2012
Item number of previous item that matches some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
FindPreviousItemNumber searches "backward" through the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist to find and return the item number of the previous 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.
Syntax
%number = anyNal:FindPreviousItemNumber( selectionCriterion, [Start= number])
Syntax terms
| %number | A numeric variable to contain the item number of the item that is located by the search. |
|---|---|
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
| selectionCriterion | A SelectionCriterion object, which is a relational expression that is applied to a anyNal 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, 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 anyNal 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 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 FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist. For a collection of three items, number may be 1, 2, 3, or 4.
This is an optional, name required, argument which defaults to one plus the number of items in the NamedArraylist. 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 FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist; the request is cancelled. If the value of Start is 1, no item can be found and the method returns a zero.
- FindPreviousItemNumber is available in Sirius Mods Version 7.6 and later.
Examples
See the FindNextItemNumber "Examples" section.
See also
- FindNextItemNumber is identical to FindPreviousItemNumber except that it searches forward in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist.