pop_states

class brainstate.graph.pop_states(node, *filters)

Remove and return ``State``s matching the filters (deduped by identity).

Parameters:

• node (Any) – The graph node to mutate.

• *filters (type | str | Callable[[Tuple[Key, ...], Any], bool] | bool | EllipsisType | None | Tuple[Filter, ...] | List[Filter]) – One or more predicates/types selecting which states to remove. At least one filter is required.

Returns:

The removed states, one mapping per filter.

Return type:

NestedDict | Tuple[NestedDict, ...]

Raises:

ValueError – If no filter is given, or a matched state lives on an immutable node.