Package com.google.common.graph

Class AbstractGraph<N>

java.lang.Object

com.google.common.graph.AbstractGraph<N>

Type Parameters:

N - Node parameter type

All Implemented Interfaces:

Graph<N>

Direct Known Subclasses:

AbstractValueGraph, ImmutableGraph

@Beta
public abstract class AbstractGraph<N>
extends java.lang.Object
implements Graph<N>

This class provides a skeletal implementation of Graph. It is recommended to extend this class rather than implement Graph directly.

Since:

20.0

Constructor Summary

Constructors

Constructor	Description
AbstractGraph()

Method Summary

Modifier and Type	Method	Description
int	degree(java.lang.Object node)	Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).
protected long	edgeCount()	Returns the number of edges in this graph; used to calculate the size of edges().
java.util.Set<EndpointPair<N>>	edges()	A reasonable default implementation of Graph.edges() defined in terms of Graph.nodes() and Graph.successors(Object).
int	inDegree(java.lang.Object node)	Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph.
int	outDegree(java.lang.Object node)	Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph.
java.lang.String	toString()	Returns a string representation of this graph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.graph.Graph

adjacentNodes, allowsSelfLoops, equals, hashCode, isDirected, nodeOrder, nodes, predecessors, successors

Constructor Detail

AbstractGraph

public AbstractGraph()

Method Detail

edgeCount

protected long edgeCount()

Returns the number of edges in this graph; used to calculate the size of edges(). The default implementation is O(|N|). You can manually keep track of the number of edges and override this method for better performance.

edges

public java.util.Set<EndpointPair<N>> edges()

A reasonable default implementation of Graph.edges() defined in terms of Graph.nodes() and Graph.successors(Object).

Specified by:

edges in interface Graph<N>

degree

public int degree(java.lang.Object node)

Description copied from interface: Graph

Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).

For directed graphs, this is equal to inDegree(node) + outDegree(node).

For undirected graphs, this is equal to adjacentNodes(node).size() + (1 if node has an incident self-loop, 0 otherwise).

If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

Specified by:

degree in interface Graph<N>

inDegree

public int inDegree(java.lang.Object node)

Description copied from interface: Graph

Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph. In an undirected graph, returns the Graph.degree(Object).

If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

Specified by:

inDegree in interface Graph<N>

outDegree

public int outDegree(java.lang.Object node)

Description copied from interface: Graph

Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph. In an undirected graph, returns the Graph.degree(Object).

If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

Specified by:

outDegree in interface Graph<N>

toString

public java.lang.String toString()

Returns a string representation of this graph.

Overrides:

toString in class java.lang.Object