mesa_frames.AgentSet.remove#

AgentSet.remove(agents: int | Collection[int] | Series | DataFrame | Sequence[int] | Literal['all', 'active'] | None | Expr, inplace: bool = True) → Self[source]#

Remove agents from this AbstractAgentSet.

Parameters:

  • agents (IdsLike | AgentMask) – The agents or mask to remove.

  • inplace (bool, optional) – Whether to remove in place, by default True.

Returns:

The updated agent set.

Return type:

Self