Effect Stack

from dgisim import EffectStack

__eq__ and __hash__ are implemented so that any two effect stacks with the equivalent content are equal to each other and have the same hash.

class EffectStack(effects: tuple[Effect, ...])

A class responsible for holding pending effects to be executed as a stack.

contains(effect_type: type[Effect]) → bool

encoding(encoding_plan: EncodingPlan) → list[int]

is_empty() → bool

is_not_empty() → bool

peek() → Effect

peek_all_left() → tuple[Effect, ...]

peek_all_rev_left() → tuple[Effect, ...]

pop_all_rev_left() → tuple[EffectStack, tuple[Effect, ...]]

push_barrier_left() → EffectStack

A barrier separates effects returned by peek_all into two groups, and only one group can be popped at a time.

push_left(effects: Effect | Sequence[Effect]) → EffectStack

Returns:: the new EffectStack with effects pushed onto it. The push follows FIFO, like a queue.

push_many_fl(effects: Sequence[Effect]) → EffectStack

fl means the effects passed in are executed from the first to the last.

push_many_lf(effects: Sequence[Effect]) → EffectStack

lf means the effects passed in are executed from the last to the first.

push_one(effect: Effect) → EffectStack