com.google.common.graph

Class ConfigurableMutableGraph<N>

java.lang.Object

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

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

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

Type Parameters:

N - Node parameter type

All Implemented Interfaces:

Graph<N>, MutableGraph<N>

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

Configurable 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 and Description
private MutableValueGraph<N,GraphConstants.Presence>	backingValueGraph

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addNode(N node) Adds node if it is not already present.
protected Graph<N>	delegate()
boolean	putEdge(N nodeU, N nodeV) Adds an edge connecting nodeU to nodeV if one is not already present.
boolean	removeEdge(java.lang.Object nodeU, java.lang.Object nodeV) Removes the edge connecting nodeU to nodeV, if it is present.
boolean	removeNode(java.lang.Object 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, edges, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors

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

edgeCount, toString

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, degree, edges, equals, hashCode, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors

Field Detail

backingValueGraph

private final MutableValueGraph<N,GraphConstants.Presence> backingValueGraph

Constructor Detail

ConfigurableMutableGraph

ConfigurableMutableGraph(AbstractGraphBuilder<? super N> builder)

Constructs a MutableGraph with the properties specified in builder.

Method Detail

delegate

protected Graph<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. In an undirected graph, the edge will also connect nodeV to nodeU.

Behavior if nodeU and nodeV are not already present in this graph is implementation-dependent. Suggested behaviors include (a) silently adding nodeU and nodeV to the graph (this is the behavior of the default implementations) or (b) throwing IllegalArgumentException.

Specified by:

putEdge in interface MutableGraph<N>

Returns:

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

removeNode

public boolean removeNode(java.lang.Object 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(java.lang.Object nodeU,
                          java.lang.Object 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