Adaptor showing all arcs of an underlying graph as undirected edges. More...

Inheritance diagram for Satsuma.UndirectedGraph:

Public Member Functions
int	ArcCount (ArcFilter filter=ArcFilter.All)
	Returns the total number of arcs satisfying a given filter. More...

int	ArcCount (Node u, ArcFilter filter=ArcFilter.All)
	Returns the number of arcs adjacent to a specific node satisfying a given filter. More...

int	ArcCount (Node u, Node v, ArcFilter filter=ArcFilter.All)
	Returns the number of arcs adjacent to two nodes satisfying a given filter. More...

IEnumerable< Arc >	Arcs (ArcFilter filter=ArcFilter.All)

IEnumerable< Arc >	Arcs (Node u, ArcFilter filter=ArcFilter.All)

IEnumerable< Arc >	Arcs (Node u, Node v, ArcFilter filter=ArcFilter.All)

bool	HasArc (Arc arc)
	Returns whether the given arc is contained in the graph. More...

bool	HasNode (Node node)
	Returns whether the given node is contained in the graph. More...

bool	IsEdge (Arc arc)
	Returns whether the arc is undirected (`true`) or directed (`false`). More...

int	NodeCount ()
	Returns the total number of nodes in O(1) time. More...

IEnumerable< Node >	Nodes ()
	Returns all nodes of the graph. More...

Node	U (Arc arc)
	Returns the first node of an arc. Directed arcs point from U to V. More...

	UndirectedGraph (IGraph graph)

Node	V (Arc arc)
	Returns the second node of an arc. Directed arcs point from U to V. More...

Detailed Description

Adaptor showing all arcs of an underlying graph as undirected edges.

Node and Arc objects are interchangeable between the adaptor and the original graph. The underlying graph can be freely modified while using this adaptor.

Definition at line 34 of file UndirectedGraph.cs.

Constructor & Destructor Documentation

Satsuma.UndirectedGraph.UndirectedGraph ( IGraph graph )

Definition at line 38 of file UndirectedGraph.cs.

Member Function Documentation

int Satsuma.UndirectedGraph.ArcCount ( ArcFilter filter = ArcFilter.All )

Returns the total number of arcs satisfying a given filter.

Parameters

filter Detailed description: see Arcs(ArcFilter).

Implements Satsuma.IGraph.

Definition at line 83 of file UndirectedGraph.cs.

int Satsuma.UndirectedGraph.ArcCount	(	Node	u,
		ArcFilter	filter = `ArcFilter.All`
	)

Returns the number of arcs adjacent to a specific node satisfying a given filter.

Parameters

filter Detailed description: see Arcs(Node, ArcFilter).

Implements Satsuma.IGraph.

Definition at line 88 of file UndirectedGraph.cs.

int Satsuma.UndirectedGraph.ArcCount	(	Node	u,
		Node	v,
		ArcFilter	filter = `ArcFilter.All`
	)

Returns the number of arcs adjacent to two nodes satisfying a given filter.

Parameters

filter Detailed description: see Arcs(Node, Node, ArcFilter).

Implements Satsuma.IGraph.

Definition at line 93 of file UndirectedGraph.cs.

IEnumerable<Arc> Satsuma.UndirectedGraph.Arcs ( ArcFilter filter = ArcFilter.All )

Returns all arcs of the graph satisfying a given filter.

Parameters

filter

Cannot be ArcType.Forward/ArcType.Backward.

If ArcFilter.All, then all arcs are returned.
If ArcFilter.Edge, only the edges (undirected arcs) are returned.

Implements Satsuma.IGraph.

Definition at line 63 of file UndirectedGraph.cs.

IEnumerable<Arc> Satsuma.UndirectedGraph.Arcs	(	Node	u,
		ArcFilter	filter = `ArcFilter.All`
	)

Returns all arcs adjacent to a specific node satisfying a given filter.

Parameters

filter

If ArcFilter.All, then all arcs are returned.
If ArcFilter.Edge, only the edges (undirected arcs) are returned.
If ArcFilter.Forward, only the arcs exiting u (this includes edges) are returned.
If ArcFilter.Backward, only the arcs entering u (this includes edges) are returned.

Implements Satsuma.IGraph.

Definition at line 68 of file UndirectedGraph.cs.

IEnumerable<Arc> Satsuma.UndirectedGraph.Arcs	(	Node	u,
		Node	v,
		ArcFilter	filter = `ArcFilter.All`
	)

Returns all arcs adjacent to two nodes satisfying a given filter.

Parameters

filter

If ArcFilter.All, then all arcs are returned.
If ArcFilter.Edge, only the edges (undirected arcs) are returned.
If ArcFilter.Forward, only the arcs from u to v (this includes edges) are returned.
If ArcFilter.Backward, only the arcs from v to u (this includes edges) are returned.

Implements Satsuma.IGraph.

Definition at line 73 of file UndirectedGraph.cs.

bool Satsuma.UndirectedGraph.HasArc ( Arc arc )

Returns whether the given arc is contained in the graph.

Must return the same value as Arcs().Contains in all implementations, but faster if possible.

Note: true may be returned for arcs coming from another graph as well, if those arcs encapsulate an identifier which is valid for this graph, too.

Implements Satsuma.IGraph.

Definition at line 103 of file UndirectedGraph.cs.

bool Satsuma.UndirectedGraph.HasNode ( Node node )

Returns whether the given node is contained in the graph.

Must return the same value as Nodes().Contains in all implementations, but faster if possible.

Note: true may be returned for nodes coming from another graph as well, if those nodes encapsulate an identifier which is valid for this graph, too.

Implements Satsuma.IGraph.

Definition at line 98 of file UndirectedGraph.cs.

bool Satsuma.UndirectedGraph.IsEdge ( Arc arc )

Returns whether the arc is undirected (true) or directed (false).

Implements Satsuma.IArcLookup.

Definition at line 53 of file UndirectedGraph.cs.

int Satsuma.UndirectedGraph.NodeCount ( )

Returns the total number of nodes in O(1) time.

Implements Satsuma.IGraph.

Definition at line 78 of file UndirectedGraph.cs.

IEnumerable<Node> Satsuma.UndirectedGraph.Nodes ( )

Returns all nodes of the graph.