Font size

Select element(s) from a collection

To select a specific element from a collection

  • top(collection, value) — Returns the element having maximum value in the given collection.
    Example: Person person = top( people, p -> p.age );
    Here we get the oldest person from the people collection. If the collection is empty, the function returns null.
  • List filter(collection, condition) — Returns a subset of a given collection — a new list with elements from the original collection which meet the given condition.
    List women = filter( people, p -> p.gender == FEMALE );
    List idleTrucks = filter( trucks, t -> t.inState(Idle) );
  • List findAll(collection, condition) — This function is the same as filter(collection, condition).
  • findFirst(collection, condition) — Returns the first element from the given collection which meets the given condition (the element which has true value of the given condition). Returns null if there is no such element or the collection is empty.
    Example: Person person = findFirst( people, p -> p.age > 20 );

To select a random element from a collection

AnyLogic provides functions to select a random element from a given collection. These functions are defined in the class Utilities and are global (accessible from each place of model code). You call any function from the list below by typing just its name, without a prefix with the collection name: randomWhere( people, p -> p.income > 10000 );

  • randomWhere(collection, condition) — Returns one randomly selected element within the given collection satisfying the specified condition. If the collection is empty, or none elements satisfy the specified condition(s), the function returns null.
    Person wealthyPerson = randomWhere( people, p -> p.income > 10000 );
    Person wealthyMan = randomWhere( people, p -> p.income > 10000 && == MALE );
    Here we check two conditions (we use logical AND operator && to tell AnyLogic that both the first AND the second condition should be true). The function returns a randomly selected element that satisfies both conditions.
    Person wealthyYoungMan = randomWhere( people, p -> p.income > 10000 && == MALE && p.age < 21 );

There is another function, enabling the user to use a custom random number generator instead of the default one:

randomWhere( collection, condition, java.util.Random r ) — Similar to randomWhere(population, condition). Uses the specified random number generator to choose the element.

How can we improve this article?