simudyne.core.abm.stats

Interface AgentStatistics<T extends Agent<? extends GlobalState>>

All Superinterfaces:

AgentSelection<T>, JSONValue, java.io.Serializable, SerializableSupplier<AgentStatisticsResult<T>>, java.util.function.Supplier<AgentStatisticsResult<T>>, VertexSelection<T>

public interface AgentStatistics<T extends Agent<? extends GlobalState>>
extends AgentSelection<T>, SerializableSupplier<AgentStatisticsResult<T>>, JSONValue

AgentStatistics provides a wrapper around VertexAggregator and Graph.selectVertices(Class) that can be customised to provide attribute level statistics via SummaryStatistics. This allows common statistics for agent attributes to be collected in a declarative manner, rather than implementing custom VertexAggregator implementations.

 AgentStatistics<MyAgent> stats =
   agentSystem.stats(MyAgent.class)
     .field("balance", agent -> agent.balance)
     .field("spending", agent -> agent.spending);
 

AgentStatistics also implements the JSONValue interface, so it may be returned from Variable annotated methods directly.

Method Summary

Modifier and Type	Method and Description
AgentStatistics<T>	field(java.lang.String propertyName, SerializableFunction<T,java.lang.Number> function) Define a field to collect statistics for.
AgentStatistics<T>	filter(SerializablePredicate<T> predicate) Applies a filter to this selection.

Methods inherited from interface simudyne.core.abm.AgentSelection

stats

Methods inherited from interface simudyne.core.graph.VertexSelection

aggregate, count

Methods inherited from interface java.util.function.Supplier

get

Methods inherited from interface simudyne.core.JSONValue

emitJSON, getRecord, getSchema, getValues, receiveJSON

Method Detail

filter

AgentStatistics<T> filter(SerializablePredicate<T> predicate)

Description copied from interface: VertexSelection

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.

Specified by:

filter in interface AgentSelection<T extends Agent<? extends GlobalState>>

Specified by:

filter in interface VertexSelection<T extends Agent<? extends GlobalState>>

Parameters:

predicate - Predicate on agents of type

Returns:

The same AgentSelection instance, with the predicate applied.

field

AgentStatistics<T> field(java.lang.String propertyName,
                         SerializableFunction<T,java.lang.Number> function)

Define a field to collect statistics for. This could either be a simple retrieval of a value from an agent, or a computed value based on multiple agent fields.

Parameters:

propertyName - Name for the field in the statistics results.

function - Function for extracting the field value from the agent.

Returns:

A new AgentStatistics instance with the field added.