Interface to a read-only path. More...

Inheritance diagram for Satsuma.IPath:

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...

Arc	NextArc (Node node)
	Returns the arc connecting a node with its successor in the path. More...

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

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

Arc	PrevArc (Node node)
	Returns the arc connecting a node with its predecessor in the path. More...

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

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

Properties
Node	FirstNode `[get]`
	The first node of the path, or Node.Invalid if the path is empty. More...

Node	LastNode `[get]`
	The last node of the path, or Node.Invalid if the path is empty. More...

Detailed Description

Interface to a read-only path.

Here path is used in a sense that no nodes may be repeated. The only exception is that the start and end nodes may be equal. In this case, the path is called a cycle if it has at least one arc.

If the path is a cycle with two nodes, then its two arcs may be equal, but this is the only case when arc equality is allowed (in fact, possible).

The path arcs may be undirected or point in any direction (forward/backward).

The Nodes method always returns the nodes in path order.

The length of a path is defined as the number of its arcs. A path is called empty if it has no nodes.

See Also: PathExtensions

Definition at line 24 of file Path.cs.

Member Function Documentation

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

inherited

Returns the total number of arcs satisfying a given filter.

Parameters

filter Detailed description: see Arcs(ArcFilter).

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.CompleteGraph, Satsuma.Subgraph, Satsuma.ContractedGraph, Satsuma.Matching, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

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

inherited

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

Parameters

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

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.Subgraph, Satsuma.CompleteGraph, Satsuma.ContractedGraph, Satsuma.Matching, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

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

inherited

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

Parameters

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

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.CompleteGraph, Satsuma.Subgraph, Satsuma.Matching, Satsuma.ContractedGraph, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

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

inherited

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.

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.Subgraph, Satsuma.CompleteGraph, Satsuma.ContractedGraph, Satsuma.Matching, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

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

inherited

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.

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.Subgraph, Satsuma.CompleteGraph, Satsuma.Matching, Satsuma.ContractedGraph, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

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

inherited

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.

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.Subgraph, Satsuma.CompleteGraph, Satsuma.ContractedGraph, Satsuma.Matching, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

bool Satsuma.IGraph.HasArc ( Arc arc )

inherited

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.

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.CompleteGraph, Satsuma.Subgraph, Satsuma.Matching, Satsuma.ContractedGraph, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.

bool Satsuma.IGraph.HasNode ( Node node )

inherited

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.

Implemented in Satsuma.PathGraph, Satsuma.Supergraph, Satsuma.Path, Satsuma.CompleteBipartiteGraph, Satsuma.CompleteGraph, Satsuma.Subgraph, Satsuma.Matching, Satsuma.ContractedGraph, Satsuma.RedirectedGraph, Satsuma.ReverseGraph, and Satsuma.UndirectedGraph.