Focus Flow

graphqomb.focus_flow module

Focus flow algorithm.

This module provides:

• is_focused: Check if a flowlike object is focused.

• focus_gflow: Focus a flowlike object.

Functions

graphqomb.focus_flow.is_focused(flowlike, graph)

Check if a flowlike object is focused.

Parameters:

• flowlike (collections.abc.Mapping[int, int] | collections.abc.Mapping[int, collections.abc.Set[int]]`) – flowlike object

• graph (BaseGraphState) – graph state

Returns:

True if the flowlike object is focused, False otherwise

Return type:

bool

Raises:

TypeError – If the flowlike object is not a Flow or GFlow

graphqomb.focus_flow.focus_gflow(flowlike, graph)

Focus a flowlike object.

Parameters:

• flowlike (collections.abc.Mapping[int, int] | collections.abc.Mapping[int, collections.abc.Set[int]]) – flowlike object

• graph (BaseGraphState) – graph state

Returns:

focused flowlike object

Return type:

dict[int, set[int]]

Raises:

TypeError – If the flowlike object is not a Flow or GFlow