mesa_frames.Grid.is_available

Grid.is_available(pos: int | DataFrame | Sequence[int] | Collection[int | DataFrame] | Sequence[int | slice | Sequence[int]] | Collection[int | Sequence[int] | DataFrame]) → DataFrame

Check whether the input positions are available (there exists at least one remaining spot in the cells).

Parameters:

pos (DiscreteCoordinate | DiscreteCoordinates) – The positions to check for

Returns:

A dataframe with positions and a boolean column “available”

Return type:

DataFrame