CountSubset (GenericNamedArraylist function)

From m204wiki
Revision as of 20:16, 2 September 2014 by JAL (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.


%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.


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