breadth_first_paths

compas.topology.breadth_first_paths(adjacency, root, goal)

Return all paths from root to goal.

Parameters:

adjacencydict[hashable, dict[hashable, None]] | dict[hashable, sequence[hashable]]

An adjacency dictionary representing the connectivity of the graph by mapping nodes identifiers to neighbour identifiers. Examples of valid adjacency dicts are

• {0: [1, 2, 3, 4], 1: [0], 2: [0], 3: [0], 4: [0]}

• {0: {1: None, 2: None, 3: None, 4: None}, 1: {0: None}, 2: {0: None}, 3: {0: None}, 4: {0: None}}

roothashable

The identifier of the starting node.

goalhashable

The identifier of the ending node.

Yields:

list[hashable]

A path from root to goal.

Notes

Due to the nature of the search, the first path returned is the shortest.