Class AbstractGraph<N>

java.lang.Object

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

Type Parameters:

N - Node parameter type

All Implemented Interfaces:

Graph<N>, PredecessorsFunction<N>, SuccessorsFunction<N>

Direct Known Subclasses:

ImmutableGraph

public abstract class AbstractGraph<N>
extends 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

Author:

James Sexton

Constructor Summary

Constructors

Constructor	Description
AbstractGraph()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
Network<N, EndpointPair<N>>	asNetwork()
int	degree(N node)
protected long	edgeCount()	Returns the number of edges in this graph; used to calculate the size of Graph.edges().
Set<EndpointPair<N>>	edges()	An implementation of BaseGraph.edges() defined in terms of Graph.nodes() and SuccessorsFunction.successors(Object).
final boolean	equals(@Nullable Object obj)	Returns true iff object is a Graph that has the same elements and the same structural relationships as those in this graph.
boolean	hasEdgeConnecting(EndpointPair<N> endpoints)
boolean	hasEdgeConnecting(N nodeU, N nodeV)
final int	hashCode()	Returns the hash code for this graph.
ElementOrder<N>	incidentEdgeOrder()
Set<EndpointPair<N>>	incidentEdges(N node)
int	inDegree(N node)
protected final boolean	isOrderingCompatible(EndpointPair<?> endpoints)	Returns true iff endpoints' ordering is compatible with the directionality of this graph.
protected final <T> Set<T>	nodeInvalidatableSet(Set<T> set, N node)
protected final <T> Set<T>	nodePairInvalidatableSet(Set<T> set, N nodeU, N nodeV)
int	outDegree(N node)
String	toString()	Returns a string representation of this graph.
protected final void	validateEndpoints(EndpointPair<?> endpoints)	Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Graph

adjacentNodes, allowsSelfLoops, degree, edges, hasEdgeConnecting, hasEdgeConnecting, incidentEdgeOrder, incidentEdges, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors

Modifier and Type	Method	Description
Set<N>	adjacentNodes(N node)	Returns a live view of the nodes which have an incident edge in common with node in this graph.
boolean	allowsSelfLoops()	Returns true if this graph allows self-loops (edges that connect a node to itself).
int	degree(N node)	Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).
Set<EndpointPair<N>>	edges()	Returns all edges in this graph.
boolean	hasEdgeConnecting(EndpointPair<N> endpoints)	Returns true if there is an edge that directly connects endpoints (in the order, if any, specified by endpoints).
boolean	hasEdgeConnecting(N nodeU, N nodeV)	Returns true if there is an edge that directly connects nodeU to nodeV.
ElementOrder<N>	incidentEdgeOrder()	Returns an ElementOrder that specifies the order of iteration for the elements of Graph.edges(), Graph.adjacentNodes(Object), Graph.predecessors(Object), Graph.successors(Object) and Graph.incidentEdges(Object).
Set<EndpointPair<N>>	incidentEdges(N node)	Returns a live view of the edges in this graph whose endpoints include node.
int	inDegree(N node)	Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph.
boolean	isDirected()	Returns true if the edges in this graph are directed.
ElementOrder<N>	nodeOrder()	Returns the order of iteration for the elements of Graph.nodes().
Set<N>	nodes()	Returns all nodes in this graph, in the order specified by Graph.nodeOrder().
int	outDegree(N node)	Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph.
Set<N>	predecessors(N node)	Returns a live view of all nodes in this graph adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.
Set<N>	successors(N node)	Returns a live view of all nodes in this graph adjacent to node which can be reached by traversing node's outgoing edges in the direction (if any) of the edge.

Constructor Details

AbstractGraph

public AbstractGraph()

Constructor for use by subclasses.

Method Details

equals

public final boolean equals(@Nullable Object obj)

Description copied from interface: Graph

Returns true iff object is a Graph that has the same elements and the same structural relationships as those in this graph.

Thus, two graphs A and B are equal if all of the following are true:

• A and B have equal directedness.
• A and B have equal node sets.
• A and B have equal edge sets.

Graph properties besides directedness do not affect equality. For example, two graphs may be considered equal even if one allows self-loops and the other doesn't. Additionally, the order in which nodes or edges are added to the graph, and the order in which they are iterated over, are irrelevant.

A reference implementation of this is provided by equals(Object).

Specified by:

equals in interface Graph<N>

Overrides:

equals in class Object

hashCode

public final int hashCode()

Description copied from interface: Graph

Returns the hash code for this graph. The hash code of a graph is defined as the hash code of the set returned by Graph.edges().

A reference implementation of this is provided by hashCode().

Specified by:

hashCode in interface Graph<N>

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of this graph.

Overrides:

toString in class Object

edgeCount

protected long edgeCount()

Returns the number of edges in this graph; used to calculate the size of Graph.edges(). This implementation requires O(|N|) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.

edges

public Set<EndpointPair<N>> edges()

An implementation of BaseGraph.edges() defined in terms of Graph.nodes() and SuccessorsFunction.successors(Object).

incidentEdgeOrder

public ElementOrder<N> incidentEdgeOrder()

incidentEdges

public Set<EndpointPair<N>> incidentEdges(N node)

degree

public int degree(N node)

inDegree

public int inDegree(N node)

outDegree

public int outDegree(N node)

hasEdgeConnecting

public boolean hasEdgeConnecting(N nodeU,
 N nodeV)

hasEdgeConnecting

public boolean hasEdgeConnecting(EndpointPair<N> endpoints)

asNetwork

public Network<N, EndpointPair<N>> asNetwork()

validateEndpoints

protected final void validateEndpoints(EndpointPair<?> endpoints)

Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.

isOrderingCompatible

protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)

Returns true iff endpoints' ordering is compatible with the directionality of this graph.

nodeInvalidatableSet

protected final <T> Set<T> nodeInvalidatableSet(Set<T> set,
 N node)

nodePairInvalidatableSet

protected final <T> Set<T> nodePairInvalidatableSet(Set<T> set,
 N nodeU,
 N nodeV)