CountSubset (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
mNo edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:GenericNamedArraylist:CountSubset subtitle}}
{{Template:GenericNamedArraylist:CountSubset subtitle}}


This page is [[under construction]].
The <var>CountSubset</var> function returns the number of items in a collection that match a
specified selection criterion. It is related to the <var>[[SubsetNew (NamedArraylist function)|SubsetNew]]</var> collection method, which returns not the count but a collection of the matching items for a specified criterion.
 
==Syntax==
==Syntax==
{{Template:GenericNamedArraylist:CountSubset syntax}}
{{Template:GenericNamedArraylist:CountSubset syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th><td>number</td></tr>
<tr><th>%number</th>
<td>A numeric variable to contain the count of matching items.</td></tr>
 
<tr><th>anyNal</th>
<tr><th>anyNal</th>
<td>GenericNamedArraylist object</td></tr>
<td>A <var>[[NamedArraylist class|NamedArraylist]]</var>, <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> object variable.</td></tr>
 
<tr><th>selectionCriterion</th>
<tr><th>selectionCriterion</th>
<td><var>SelectionCriterion</var> object</td></tr>
<td>A <var>[[SelectionCriterion class|SelectionCriterion]]</var> object, which is a relational expression that is applied to each collection item value to determine whether the value satisfies the expression.
<p>
For example, <code>GT(income, 0)</code> is the criterion <code>income > 0</code>, where <var>income</var> is a class variable whose value is returned for each item. The items that satisfy the expression populate the subset whose count <var>CountSubset</var> returns.</p>
<p>
For more information about the function in the criterion, see [[SelectionCriterion class#Specifying a SelectionCriterion's parameters|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<li>A <var>CountSubset</var> call with a particular selection criterion is equivalent to a count of the items in the subset returned by the <var>SubsetNew</var> method with that criterion.
</ul>
==Examples==
==Examples==
For the collection whose items are the odd integers between 0 and 10, and the selection criterion <code>LT(this, 9))</code>, <var>CountSubset</var> returns <code>4</code>.
==See also==
==See also==
{{Template:GenericNamedArraylist:CountSubset footer}}
{{Template:GenericNamedArraylist:CountSubset footer}}

Latest revision as of 20:16, 2 September 2014

Number of items that match some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)

[Introduced in Sirius Mods 7.8]


The CountSubset function returns the number of items in a collection that match a specified selection criterion. It is related to the SubsetNew collection method, which returns not the count but a collection of the matching items for a specified criterion.

Syntax

%number = anyNal:CountSubset( selectionCriterion)

Syntax terms

%number A numeric variable to contain the count of matching items.
anyNal A NamedArraylist, FloatNamedArraylist, or UnicodeNamedArraylist object variable.
selectionCriterion A SelectionCriterion object, which is a relational expression that is applied to each collection item value to determine whether the value satisfies the expression.

For example, GT(income, 0) is the criterion income > 0, where income is a class variable whose value is returned for each item. The items that satisfy the expression populate the subset whose count CountSubset returns.

For more information about the function in the criterion, see "Specifying a SelectionCriterion's parameters".

Usage notes

  • A CountSubset call with a particular selection criterion is equivalent to a count of the items in the subset returned by the SubsetNew method with that criterion.

Examples

For the collection whose items are the odd integers between 0 and 10, and the selection criterion LT(this, 9)), CountSubset returns 4.

See also