Skip to content

Matching #

Bases: object

A Matching (i.e., a set of edges that do not share any nodes)

__bool__() #

True if self else False

__contains__(key) #

Return bool(key in self).

__iter__() #

Implement iter(self).

__len__() #

Return len(self).

__repr__() #

Return repr(self).

dst(src) #

Get the matched destination node for a source node

Parameters:

Name Type Description Default
src NodeInput

The source node

required

Returns:

Type Description
Optional[Node]

The matched destination node if it exists

edge_for_dst(dst) #

Get the matched edge for a destination node

Parameters:

Name Type Description Default
dst NodeInput

The source node

required

Returns:

Type Description
Optional[Edge]

The matched edge if it exists

edge_for_src(src) #

Get the matched edge for a source node

Parameters:

Name Type Description Default
src NodeInput

The source node

required

Returns:

Type Description
Optional[Edge]

The matched edge if it exists

edges() #

Get a view of the matched edges

Returns:

Type Description
Edges

The edges in the matching

src(dst) #

Get the matched source node for a destination node

Parameters:

Name Type Description Default
dst NodeInput

The destination node

required

Returns:

Type Description
Optional[Node]

The matched source node if it exists