Uses of Class
modelarium.entities.agentsets.AgentSet

Packages that use AgentSet

Package	Description
modelarium.entities.agentsets	Provides mutable and read-only collections of agents.
modelarium.entities.contexts	Defines the simulation views supplied to attribute behaviour.
modelarium.entities.generators	Provides extension points for constructing a model's agents and environment.
modelarium.multithreading	Implements Modelarium's worker and co-ordinator runtime.
modelarium.scheduler	Provides policies for ordering local agent execution on each tick.
modelarium.scheduler.functional	Provides a lambda-backed scheduler and its tick function interface.

Uses of AgentSet in modelarium.entities.agentsets

Methods in modelarium.entities.agentsets that return AgentSet

Modifier and Type	Method	Description
AgentSet	AgentSet.duplicate()	Returns a duplicate of this agent set.
AgentSet	AgentSet.getFilteredAgents(Predicate<ReadOnlyAgent> agentFilter)	Returns a living-only filtered view of the agent set.
AgentSet	AgentSet.getFilteredAgents(Predicate<ReadOnlyAgent> agentFilter, boolean includeDeadAgents)	Returns a filtered view of the agent set.

Methods in modelarium.entities.agentsets with parameters of type AgentSet

Modifier and Type	Method	Description
void	AgentSet.add(AgentSet agentSet)	Adds all agents from another AgentSet.
void	AgentSet.addDeepCopy(AgentSet agentSet)	Adds a deep copy of each agent from another AgentSet.
void	AgentSet.update(AgentSet otherAgentSet, boolean areDeepCopied)	Updates this set with all agents from another set.

Constructors in modelarium.entities.agentsets with parameters of type AgentSet

Modifier	Constructor	Description
	ReadOnlyAgentSet(AgentSet mutableVersion)	Constructs a new immutable agent set wrapping the specified mutable agent set.

Uses of AgentSet in modelarium.entities.contexts

Methods in modelarium.entities.contexts that return AgentSet

Modifier and Type	Method	Description
protected AgentSet	SimulationContext.localAgentSet()	Returns the entity's local agent set.

Methods in modelarium.entities.contexts with parameters of type AgentSet

Modifier and Type	Method	Description
void	Context.addAgents(AgentSet agentSet)	Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.
void	EntityContext.addAgents(AgentSet agentSet)	Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.
void	SimulationContext.addAgents(AgentSet agentSet)	Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.

Uses of AgentSet in modelarium.entities.generators

Methods in modelarium.entities.generators that return AgentSet

Modifier and Type	Method	Description
AgentSet	DefaultAgentGenerator.generateAgents(Config config, RandomGenerator random)	Generates a complete AgentSet based on the number of agents specified in the model settings.

Methods in modelarium.entities.generators that return types with arguments of type AgentSet

Modifier and Type	Method	Description
abstract List<AgentSet>	AgentGenerator.generateAgentsForEachThread(Config config, RandomGenerator random)	Generates the model's agents and distributes them across the model's worker cores.
List<AgentSet>	DefaultAgentGenerator.generateAgentsForEachThread(Config config, RandomGenerator random)	Distributes agents across processing threads in a round-robin fashion.
List<AgentSet>	FunctionalAgentGenerator.generateAgentsForEachThread(Config config, RandomGenerator random)	Generates the model's agents using the logic specified during construction and distributes them across the model's worker cores.

Constructor parameters in modelarium.entities.generators with type arguments of type AgentSet

Modifier	Constructor	Description
	FunctionalAgentGenerator(BiFunction<Config,RandomGenerator,List<AgentSet>> getAgentsForEachThreadFunction)	Constructs a new generator with the specified logic and uses the default reset logic.
	FunctionalAgentGenerator(BiFunction<Config,RandomGenerator,List<AgentSet>> getAgentsForEachThreadFunction, Runnable resetFunction)	Constructs a new generator with the specified logic.

Uses of AgentSet in modelarium.multithreading

Constructors in modelarium.multithreading with parameters of type AgentSet

Modifier	Constructor	Description
	CoordinatorThread(String name, Config config, Environment environment, modelarium.multithreading.requestresponse.RequestResponseController requestResponseController, modelarium.clock.Clock sharedClock, AgentSet predefinedGlobalAgentSet, Map<String,String> agentThreadMap)	Constructs the coordinator thread with required references.
	WorkerThread(String threadName, Config config, modelarium.multithreading.requestresponse.RequestResponseController requestResponseController, Environment environment, AgentSet agentsInThread, modelarium.clock.Clock sharedClock, RandomGenerator randomGenerator)	Constructs a new worker thread to simulate a subset of agents.

Uses of AgentSet in modelarium.scheduler

Methods in modelarium.scheduler with parameters of type AgentSet

Modifier and Type	Method	Description
void	InOrderScheduler.runTick(String threadName, ReadOnlyClock clock, ReadOnlyEnvironment environment, AgentSet agentSet, RandomGenerator random)	Executes each agent's run() method in the order they are stored in the agent set.
void	RandomOrderScheduler.runTick(String threadName, ReadOnlyClock clock, ReadOnlyEnvironment environment, AgentSet agentSet, RandomGenerator random)	Executes each agent's run() method in a randomised order.
void	Scheduler.runTick(String threadName, ReadOnlyClock clock, ReadOnlyEnvironment environment, AgentSet agentSet, RandomGenerator random)	Executes a single simulation tick for the provided agent set.

Uses of AgentSet in modelarium.scheduler.functional

Methods in modelarium.scheduler.functional with parameters of type AgentSet

Modifier and Type	Method	Description
void	FunctionalScheduler.runTick(String threadName, ReadOnlyClock clock, ReadOnlyEnvironment environment, AgentSet agentSet, RandomGenerator random)	Executes a single simulation tick by delegating to the user-provided function.
void	TickFunction.runTick(String threadName, ReadOnlyClock clock, ReadOnlyEnvironment environment, AgentSet agentSet, RandomGenerator randomGenerator)	Executes a single simulation tick for the provided agent set.