Interface Scheduler

Interface for agent schedulers.

A scheduler determines which agents should tick at any given time step. Different implementations allow for different scheduling patterns:

Interval-based (every N ticks)
Priority queue (discrete event simulation)
Custom patterns

Since

0.6.0

interface Scheduler {
    getAgentsForTick(time: number): Agent[];
    nextScheduledTime(): number;
    onAgentAdded(agent: Agent, time: number): void;
    onAgentRemoved(agent: Agent): void;
    reset(): void;
    schedule(agent: Agent, time: number): void;
    unschedule(agent: Agent): void;
}

Implemented by

Index

Methods

getAgentsForTick nextScheduledTime onAgentAdded onAgentRemoved reset schedule unschedule

Methods

getAgentsForTick

getAgentsForTick(time: number): Agent[]
Get all agents scheduled to tick at the given time.
Parameters
- time: number
  The current environment time
Returns Agent[]
Array of agents that should tick
- Defined in scheduling/Scheduler.ts:41

nextScheduledTime

nextScheduledTime(): number
Get the next time at which any agent is scheduled. Used for event-driven simulation to skip empty time steps.

Returns number
The next scheduled time, or null if nothing is scheduled
- Defined in scheduling/Scheduler.ts:48

onAgentAdded

onAgentAdded(agent: Agent, time: number): void
Called when an agent is added to the environment.
Parameters
- agent: Agent
  The newly added agent
- time: number
  Current environment time
Returns void
- Defined in scheduling/Scheduler.ts:55

onAgentRemoved

onAgentRemoved(agent: Agent): void
Called when an agent is removed from the environment.
Parameters
- agent: Agent
  The agent being removed
Returns void
- Defined in scheduling/Scheduler.ts:61

reset

reset(): void
Reset the scheduler state.

Returns void
- Defined in scheduling/Scheduler.ts:66

schedule

schedule(agent: Agent, time: number): void
Schedule an agent to tick at a specific time.
Parameters
- agent: Agent
  The agent to schedule
- time: number
  The time at which the agent should tick
Returns void
- Defined in scheduling/Scheduler.ts:28

unschedule

unschedule(agent: Agent): void
Remove an agent from the schedule entirely.
Parameters
- agent: Agent
  The agent to unschedule
Returns void
- Defined in scheduling/Scheduler.ts:34