TopologyDiagram.auxiliary_trails
- TopologyDiagram.auxiliary_trails(keys=False)[source]
Iterate over all the available auxiliary trails in the topology diagram.
- Parameters:
keys (
bool, optional) – Defaults toFalse.- Yields:
aux_trail (
listorTuple[int, List[int]]) – The next auxiliary trail ifkeysisFalse. Otherwise, a tuple with the trail key and the keys of the nodes on the auxiliary trail.
Notes
An auxiliary trail is a helper trail with two nodes.