Struct Grid2DSingle 

pub struct Grid2DSingle { /* private fields */ }

Single-occupancy 2D grid space.

Each cell holds at most one agent. Attempting to add an agent to an occupied cell returns GridError::Occupied.

Backed by a flat Vec<Option<AgentId>> of size width x height.

Implementations

impl Grid2DSingle

pub fn new(width: usize, height: usize, periodic: bool) -> Self

Create a new single-occupancy grid.

Panics

Panics if width or height is zero.

pub fn dimensions(&self) -> (usize, usize)

Grid dimensions as (width, height).

pub fn periodic(&self) -> bool

Whether the grid wraps around (toroidal boundaries).

pub fn is_in_bounds(&self, pos: GridPos2) -> bool

Check whether a position is within the grid bounds.

pub fn is_empty(&self, pos: GridPos2) -> bool

Check whether a cell is unoccupied.

pub fn id_in_position(&self, pos: GridPos2) -> Option<AgentId>

Return the agent ID at a given position, or None if empty or out of bounds.

pub fn add_agent(&mut self, pos: GridPos2, id: AgentId) -> Result<(), GridError>

Register an agent at a position. Returns GridError::Occupied if the cell is taken.

pub fn remove_agent( &mut self, pos: GridPos2, id: AgentId, ) -> Result<bool, GridError>

Deregister an agent from a position. Returns Ok(true) if found and removed.

Trait Implementations

impl Clone for Grid2DSingle

fn clone(&self) -> Grid2DSingle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Grid2DSingle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A> SpaceInteraction<A> for Grid2DSingle

where A: PositionedAgent<Position = GridPos2>,

type Error = GridError

Error type for space operations.

fn random_position<R: RngCore>(&self, rng: &mut R) -> A::Position

Generate a random valid position within this space.

fn add_agent(&mut self, agent: &A) -> Result<(), Self::Error>

Register an agent with the space at its current position.

fn remove_agent(&mut self, agent: &A) -> Result<(), Self::Error>

Deregister an agent from the space.

fn nearby_ids(&self, position: &A::Position, radius: usize) -> Vec<AgentId>

Return all agent IDs within radius of position.

impl Space for Grid2DSingle