A path or cycle graph on a given number of nodes. More...

Inheritance diagram for Satsuma.PathGraph:

Public Types
enum	Topology { Path, Cycle }

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)

Node	GetNode (int index)
	Gets a node of the path by its index. More...

int	GetNodeIndex (Node node)
	Gets the index of a path node. More...

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

	PathGraph (int nodeCount, Topology topology, Directedness directedness)

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]`

Node	LastNode `[get]`

Detailed Description

A path or cycle graph on a given number of nodes.

Warning: Not to be confused with Path. Path is an adaptor which stores a path or cycle of some other graph, while PathGraph is a standalone graph (a "graph constant").

Memory usage: O(1).

This type is thread safe.

See Also: Path

Definition at line 310 of file Path.cs.

Member Enumeration Documentation

enum Satsuma.PathGraph.Topology

Enumerator
Path	The graph is a path.
Cycle	The graph is a cycle.

Definition at line 318 of file Path.cs.

Constructor & Destructor Documentation

Satsuma.PathGraph.PathGraph	(	int	nodeCount,
		Topology	topology,
		Directedness	directedness
	)

Definition at line 326 of file Path.cs.

Member Function Documentation

int Satsuma.PathGraph.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 408 of file Path.cs.

int Satsuma.PathGraph.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 413 of file Path.cs.

int Satsuma.PathGraph.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 418 of file Path.cs.

IEnumerable<Arc> Satsuma.PathGraph.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 381 of file Path.cs.

IEnumerable<Arc> Satsuma.PathGraph.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 388 of file Path.cs.

IEnumerable<Arc> Satsuma.PathGraph.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 393 of file Path.cs.

Node Satsuma.PathGraph.GetNode ( int index )

Gets a node of the path by its index.

Parameters

index An integer between 0 (inclusive) and NodeCount() (exclusive).

Definition at line 335 of file Path.cs.

int Satsuma.PathGraph.GetNodeIndex ( Node node )

Gets the index of a path node.

Returns: An integer between 0 (inclusive) and NodeCount() (exclusive).

Definition at line 342 of file Path.cs.

bool Satsuma.PathGraph.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 428 of file Path.cs.

bool Satsuma.PathGraph.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 423 of file Path.cs.

bool Satsuma.PathGraph.IsEdge ( Arc arc )

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

Implements Satsuma.IArcLookup.

Definition at line 370 of file Path.cs.

Arc Satsuma.PathGraph.NextArc ( Node node )

Returns the arc connecting a node with its successor in the path.

Returns Arc.Invalid if the node is not on the path or has no successor. If the path is a cycle, then each node has a successor.

Implements Satsuma.IPath.

Definition at line 347 of file Path.cs.

int Satsuma.PathGraph.NodeCount ( )