simudyne.core.graph

Interface VertexSelection<V extends Vertex>

Type Parameters:

V - The type of agent the selection is operating on.

All Known Subinterfaces:

AgentSelection<T>, AgentStatistics<T>

public interface VertexSelection<V extends Vertex>

AgentSelections allow the collection of statistics on selections of agents of the same type within an Graph. Selections are created via the Graph.selectVertices(Class) method.

Selections are lazy, and so are only executed when a final operation is applied, such as count().

Method Summary

Modifier and Type	Method and Description
<S extends VertexAggregator<V,S>> S	aggregate(SerializableSupplier<S> aggregatorFactory) Runs a custom aggregation over this selection.
long	count() Counts the number of agents in the selection.
VertexSelection<V>	filter(SerializablePredicate<V> predicate) Applies a filter to this selection.

Method Detail

filter

VertexSelection<V> filter(SerializablePredicate<V> predicate)

Applies a filter to this selection. The supplied SerializablePredicate predicate will be run on each agent, and its return value will determine if the agent remains in the selection or not.

Parameters:

predicate - Predicate on agents of type T

Returns:

The same AgentSelection instance, with the predicate applied.

count

long count()

Counts the number of agents in the selection.

This is a final operation, and will cause the selection to execute.

Returns:

The number of agents in the selection.

aggregate

<S extends VertexAggregator<V,S>> S aggregate(SerializableSupplier<S> aggregatorFactory)

Runs a custom aggregation over this selection. The argument is a factory for VertexAggregator implementations, as multiple aggregator instances will be created on demand, as this is executed in parallel.

Type Parameters:

S - The VertexAggregator implementation class type.

Parameters:

aggregatorFactory - A Supplier of VertexAggregator implementation instances.

Returns:

The resulting merged VertexAggregator instance.