Package com.google.common.graph

Interface MutableNetwork<N,E>

Type Parameters:

N - Node parameter type

E - Edge parameter type

All Superinterfaces:

Network<N,E>, PredecessorsFunction<N>, SuccessorsFunction<N>

@Beta
public interface MutableNetwork<N,E>
extends Network<N,E>

A subinterface of Network which adds mutation methods. When mutation is not required, users should prefer the Network interface.

Since:

20.0

Author:

James Sexton, Joshua O'Madadhain

Method Summary

Modifier and Type	Method	Description
boolean	addEdge(EndpointPair<N> endpoints, E edge)	Adds edge connecting endpoints.
boolean	addEdge(N nodeU, N nodeV, E edge)	Adds edge connecting nodeU to nodeV.
boolean	addNode(N node)	Adds node if it is not already present.
boolean	removeEdge(E edge)	Removes edge from this network, 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 interface com.google.common.graph.Network

adjacentEdges, adjacentNodes, allowsParallelEdges, allowsSelfLoops, asGraph, degree, edgeConnecting, edgeConnecting, edgeConnectingOrNull, edgeConnectingOrNull, edgeOrder, edges, edgesConnecting, edgesConnecting, equals, hasEdgeConnecting, hasEdgeConnecting, hashCode, incidentEdges, incidentNodes, inDegree, inEdges, isDirected, nodeOrder, nodes, outDegree, outEdges, predecessors, successors

Method Detail

addNode

@CanIgnoreReturnValue
boolean addNode(N node)

Adds node if it is not already present.

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

Returns:

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

addEdge

@CanIgnoreReturnValue
boolean addEdge(N nodeU,
                N nodeV,
                E edge)

Adds edge connecting nodeU to nodeV.

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

edge must be unique to this graph, just as a Map key must be. It must also be non-null.

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

If edge already connects nodeU to nodeV (in the specified order if this network Network.isDirected(), else in any order), then this method will have no effect.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if edge already exists in the graph and does not connect nodeU to nodeV

java.lang.IllegalArgumentException - if the introduction of the edge would violate Network.allowsParallelEdges() or Network.allowsSelfLoops()

addEdge

@CanIgnoreReturnValue
boolean addEdge(EndpointPair<N> endpoints,
                E edge)

Adds edge connecting endpoints. In an undirected network, edge will also connect nodeV to nodeU.

If this graph is directed, edge will be directed in this graph; if it is undirected, edge will be undirected in this graph.

If this graph is directed, endpoints must be ordered.

edge must be unique to this graph, just as a Map key must be. It must also be non-null.

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

If edge already connects an endpoint pair equal to endpoints, then this method will have no effect.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if edge already exists in the graph and connects some other endpoint pair that is not equal to endpoints

java.lang.IllegalArgumentException - if the introduction of the edge would violate Network.allowsParallelEdges() or Network.allowsSelfLoops()

java.lang.IllegalArgumentException - if the endpoints are unordered and the graph is directed

Since:

27.1

removeNode

@CanIgnoreReturnValue
boolean removeNode(N node)

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

Returns:

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

removeEdge

@CanIgnoreReturnValue
boolean removeEdge(E edge)

Removes edge from this network, if it is present.

Returns:

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