Package com.google.common.graph

Class StandardMutableGraph<N>

java.lang.Object

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

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

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

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

Type Parameters:

N - Node parameter type

All Implemented Interfaces:

BaseGraph<N>, Graph<N>, MutableGraph<N>, PredecessorsFunction<N>, SuccessorsFunction<N>

final class StandardMutableGraph<N>
extends ForwardingGraph<N>
implements MutableGraph<N>

Standard implementation of MutableGraph that supports both directed and undirected graphs. Instances of this class should be constructed with GraphBuilder.

Time complexities for mutation methods are all O(1) except for removeNode(N node), which is in O(d_node) where d_node is the degree of node.

Field Summary

Fields

Modifier and Type	Field	Description
private MutableValueGraph<N,GraphConstants.Presence>	backingValueGraph

Constructor Summary

Constructors

Constructor	Description
StandardMutableGraph(AbstractGraphBuilder<? super N> builder)	Constructs a MutableGraph with the properties specified in builder.

Method Summary

Modifier and Type	Method	Description
boolean	addNode(N node)	Adds node if it is not already present.
protected BaseGraph<N>	delegate()
boolean	putEdge(EndpointPair<N> endpoints)	Adds an edge connecting endpoints (in the order, if any, specified by endpoints) if one is not already present.
boolean	putEdge(N nodeU, N nodeV)	Adds an edge connecting nodeU to nodeV if one is not already present.
boolean	removeEdge(EndpointPair<N> endpoints)	Removes the edge connecting endpoints, if it is present.
boolean	removeEdge(N nodeU, N nodeV)	Removes the edge connecting nodeU to nodeV, if it is present.
boolean	removeNode(N node)	Removes node if it is present; all edges incident to node will also be removed.

Methods inherited from class com.google.common.graph.ForwardingGraph

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

Methods inherited from class com.google.common.graph.AbstractGraph

equals, hashCode, toString

Methods inherited from class com.google.common.graph.AbstractBaseGraph

edges, isOrderingCompatible, validateEndpoints

Methods inherited from class java.lang.Object

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

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

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

Field Detail

backingValueGraph

private final MutableValueGraph<N,GraphConstants.Presence> backingValueGraph

Constructor Detail

StandardMutableGraph

StandardMutableGraph(AbstractGraphBuilder<? super N> builder)

Constructs a MutableGraph with the properties specified in builder.

Method Detail

delegate

protected BaseGraph<N> delegate()

Specified by:

delegate in class ForwardingGraph<N>

addNode

public boolean addNode(N node)

Description copied from interface: MutableGraph

Adds node if it is not already present.

Nodes must be unique, just as Map keys must be. They must also be non-null.

Specified by:

addNode in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call

putEdge

public boolean putEdge(N nodeU,
                       N nodeV)

Description copied from interface: MutableGraph

Adds an edge connecting nodeU to nodeV if one is not already present.

If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected.

If nodeU and nodeV are not already present in this graph, this method will silently add nodeU and nodeV to the graph.

Specified by:

putEdge in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call

putEdge

public boolean putEdge(EndpointPair<N> endpoints)

Description copied from interface: MutableGraph

Adds an edge connecting endpoints (in the order, if any, specified by endpoints) if one is not already present.

If this graph is directed, endpoints must be ordered and the added edge will be directed; if it is undirected, the added edge will be undirected.

If this graph is directed, endpoints must be ordered.

If either or both endpoints are not already present in this graph, this method will silently add each missing endpoint to the graph.

Specified by:

putEdge in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call

removeNode

public boolean removeNode(N node)

Description copied from interface: MutableGraph

Removes node if it is present; all edges incident to node will also be removed.

Specified by:

removeNode in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call

removeEdge

public boolean removeEdge(N nodeU,
                          N nodeV)

Description copied from interface: MutableGraph

Removes the edge connecting nodeU to nodeV, if it is present.

Specified by:

removeEdge in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call

removeEdge

public boolean removeEdge(EndpointPair<N> endpoints)

Description copied from interface: MutableGraph

Removes the edge connecting endpoints, if it is present.

If this graph is directed, endpoints must be ordered.

Specified by:

removeEdge in interface MutableGraph<N>

Returns:

true if the graph was modified as a result of this call