Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.graph.Network

Method Summary

Modifier and Type	Method and Description
public Set<E>	adjacentEdges(E edge) Returns a live view of the edges which have an `incident node` in common with `edge`.
public Set<N>	adjacentNodes(N node) Returns a live view of the nodes which have an incident edge in common with `node` in this graph.
public boolean	allowsParallelEdges() Returns true if this network allows parallel edges.
public boolean	allowsSelfLoops() Returns true if this network allows self-loops (edges that connect a node to itself).
public Graph<N>	asGraph() Returns a live view of this network as a `Graph`.
public 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`).
public Optional<E>	edgeConnecting(N nodeU, N nodeV) Returns the single edge that directly connects `nodeU` to `nodeV`, if one is present, or `Optional.empty()` if no such edge exists.
public Optional<E>	edgeConnecting(EndpointPair<N> endpoints) Returns the single edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`), if one is present, or `Optional.empty()` if no such edge exists.
public E	edgeConnectingOrNull(N nodeU, N nodeV) Returns the single edge that directly connects `nodeU` to `nodeV`, if one is present, or `null` if no such edge exists.
public E	edgeConnectingOrNull(EndpointPair<N> endpoints) Returns the single edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`), if one is present, or `null` if no such edge exists.
public ElementOrder<E>	edgeOrder() Returns the order of iteration for the elements of `edges()`.
public Set<E>	edges() Returns all edges in this network, in the order specified by `edgeOrder()`.
public Set<E>	edgesConnecting(N nodeU, N nodeV) Returns a live view of the set of edges that each directly connect `nodeU` to `nodeV`.
public Set<E>	edgesConnecting(EndpointPair<N> endpoints) Returns a live view of the set of edges that each directly connect `endpoints` (in the order, if any, specified by `endpoints`).
public boolean	equals(Object object) Returns `true` iff `object` is a `Network` that has the same elements and the same structural relationships as those in this network.
public boolean	hasEdgeConnecting(N nodeU, N nodeV) Returns true if there is an edge that directly connects `nodeU` to `nodeV`.
public boolean	hasEdgeConnecting(EndpointPair<N> endpoints) Returns true if there is an edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`).
public int	hashCode() Returns the hash code for this network.
public Set<E>	incidentEdges(N node) Returns a live view of the edges whose `incident nodes` in this network include `node`.
public EndpointPair<N>	incidentNodes(E edge) Returns the nodes which are the endpoints of `edge` in this network.
public int	inDegree(N node) Returns the count of `node`'s `incoming edges` in a directed network.
public Set<E>	inEdges(N node) Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at `node`.
public boolean	isDirected() Returns true if the edges in this network are directed.
public ElementOrder<N>	nodeOrder() Returns the order of iteration for the elements of `nodes()`.
public Set<N>	nodes() Returns all nodes in this network, in the order specified by `nodeOrder()`.
public int	outDegree(N node) Returns the count of `node`'s `outgoing edges` in a directed network.
public Set<E>	outEdges(N node) Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from `node`.
public Set<N>	predecessors(N node) Redeclares com.google.common.graph.PredecessorsFunction.predecessors. Returns a live view of all nodes in this network adjacent to `node` which can be reached by traversing `node`'s incoming edges against the direction (if any) of the edge.
public Set<N>	successors(N node) Redeclares com.google.common.graph.SuccessorsFunction.successors. Returns a live view of all nodes in this network adjacent to `node` which can be reached by traversing `node`'s outgoing edges in the direction (if any) of the edge.

Method Detail

adjacentEdges back to summary

adjacentEdges	back to summary
public Set<E> adjacentEdges(E edge) Returns a live view of the edges which have an `incident node` in common with `edge`. An edge is not considered adjacent to itself. If `edge` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `edge` is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `edge` is not an element of this network

public Set<E> adjacentEdges(E edge)

Returns a live view of the edges which have an incident node in common with edge. An edge is not considered adjacent to itself.

If edge is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if edge is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if edge is not an element of this network

adjacentNodes back to summary

adjacentNodes	back to summary
public Set<N> adjacentNodes(N node) Returns a live view of the nodes which have an incident edge in common with `node` in this graph. This is equal to the union of `predecessors(Object)` and `successors(Object)`. If `node` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `node` is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `node` is not an element of this network

public Set<N> adjacentNodes(N node)

Returns a live view of the nodes which have an incident edge in common with node in this graph.

This is equal to the union of predecessors(Object) and successors(Object).

If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if node is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if node is not an element of this network

allowsParallelEdges	back to summary
public boolean allowsParallelEdges() Returns true if this network allows parallel edges. Attempting to add a parallel edge to a network that does not allow them will throw an `IllegalArgumentException`.

allowsSelfLoops	back to summary
public boolean allowsSelfLoops() Returns true if this network allows self-loops (edges that connect a node to itself). Attempting to add a self-loop to a network that does not allow them will throw an `IllegalArgumentException`.

asGraph back to summary

asGraph	back to summary
public Graph<N> asGraph() Returns a live view of this network as a `Graph`. The resulting `Graph` will have an edge connecting node A to node B if this `Network` has an edge connecting A to B. If this network `allows parallel edges`, parallel edges will be treated as if collapsed into a single edge. For example, the `degree(Object)` of a node in the `Graph` view may be less than the degree of the same node in this `Network`.

public Graph<N> asGraph()

Returns a live view of this network as a Graph. The resulting Graph will have an edge connecting node A to node B if this Network has an edge connecting A to B.

If this network allows parallel edges, parallel edges will be treated as if collapsed into a single edge. For example, the degree(Object) of a node in the Graph view may be less than the degree of the same node in this Network.

degree back to summary

degree	back to summary
public 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`). For directed networks, this is equal to `inDegree(node) + outDegree(node)`. For undirected networks, this is equal to `incidentEdges(node).size()` + (number of self-loops incident to `node`). If the count is greater than `Integer.MAX_VALUE`, returns `Integer.MAX_VALUE`. Exceptions IllegalArgumentException: if `node` is not an element of this network

public 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).

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

For undirected networks, this is equal to incidentEdges(node).size() + (number of self-loops incident to node).

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

Exceptions

IllegalArgumentException:: if node is not an element of this network

edgeConnecting back to summary

edgeConnecting	back to summary
public Optional<E> edgeConnecting(N nodeU, N nodeV) Returns the single edge that directly connects `nodeU` to `nodeV`, if one is present, or `Optional.empty()` if no such edge exists. In an undirected network, this is equal to `edgeConnecting(nodeV, nodeU)`. Exceptions IllegalArgumentException: if there are multiple parallel edges connecting `nodeU` to `nodeV` if `nodeU` or `nodeV` is not an element of this network Since 23.0

public Optional<E> edgeConnecting(N nodeU, N nodeV)

Returns the single edge that directly connects nodeU to nodeV, if one is present, or Optional.empty() if no such edge exists.

In an undirected network, this is equal to edgeConnecting(nodeV, nodeU).

Exceptions

IllegalArgumentException:

if there are multiple parallel edges connecting nodeU to nodeV
if nodeU or nodeV is not an element of this network

Since

23.0

edgeConnecting back to summary

edgeConnecting	back to summary
public Optional<E> edgeConnecting(EndpointPair<N> endpoints) Returns the single edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`), if one is present, or `Optional.empty()` if no such edge exists. If this network is directed, the endpoints must be ordered. Exceptions IllegalArgumentException: if there are multiple parallel edges connecting `nodeU` to `nodeV` if either endpoint is not an element of this network if the endpoints are unordered and the network is directed Since 27.1

public Optional<E> edgeConnecting(EndpointPair<N> endpoints)

Returns the single edge that directly connects endpoints (in the order, if any, specified by endpoints), if one is present, or Optional.empty() if no such edge exists.

If this network is directed, the endpoints must be ordered.

Exceptions

IllegalArgumentException:

if there are multiple parallel edges connecting nodeU to nodeV
if either endpoint is not an element of this network
if the endpoints are unordered and the network is directed

Since

27.1

edgeConnectingOrNull back to summary

edgeConnectingOrNull	back to summary
public E edgeConnectingOrNull(N nodeU, N nodeV) Returns the single edge that directly connects `nodeU` to `nodeV`, if one is present, or `null` if no such edge exists. In an undirected network, this is equal to `edgeConnectingOrNull(nodeV, nodeU)`. Annotations @CheckForNull Exceptions IllegalArgumentException: if there are multiple parallel edges connecting `nodeU` to `nodeV` if `nodeU` or `nodeV` is not an element of this network Since 23.0

public E edgeConnectingOrNull(N nodeU, N nodeV)

Returns the single edge that directly connects nodeU to nodeV, if one is present, or null if no such edge exists.

In an undirected network, this is equal to edgeConnectingOrNull(nodeV, nodeU).

Annotations

@CheckForNull

Exceptions

IllegalArgumentException:

if there are multiple parallel edges connecting nodeU to nodeV
if nodeU or nodeV is not an element of this network

Since

23.0

edgeConnectingOrNull back to summary

edgeConnectingOrNull	back to summary
public E edgeConnectingOrNull(EndpointPair<N> endpoints) Returns the single edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`), if one is present, or `null` if no such edge exists. If this network is directed, the endpoints must be ordered. Annotations @CheckForNull Exceptions IllegalArgumentException: if there are multiple parallel edges connecting `nodeU` to `nodeV` if either endpoint is not an element of this network if the endpoints are unordered and the network is directed Since 27.1

public E edgeConnectingOrNull(EndpointPair<N> endpoints)

Returns the single edge that directly connects endpoints (in the order, if any, specified by endpoints), if one is present, or null if no such edge exists.

If this network is directed, the endpoints must be ordered.

Annotations

@CheckForNull

Exceptions

IllegalArgumentException:

if there are multiple parallel edges connecting nodeU to nodeV
if either endpoint is not an element of this network
if the endpoints are unordered and the network is directed

Since

27.1

edgeOrder	back to summary
public ElementOrder<E> edgeOrder() Returns the order of iteration for the elements of `edges()`.

edges	back to summary
public Set<E> edges() Returns all edges in this network, in the order specified by `edgeOrder()`.

edgesConnecting back to summary

edgesConnecting	back to summary
public Set<E> edgesConnecting(N nodeU, N nodeV) Returns a live view of the set of edges that each directly connect `nodeU` to `nodeV`. In an undirected network, this is equal to `edgesConnecting(nodeV, nodeU)`. The resulting set of edges will be parallel (i.e. have equal `incidentNodes(Object)`). If this network does not `allow parallel edges`, the resulting set will contain at most one edge (equivalent to `edgeConnecting(nodeU, nodeV).asSet()`). If either `nodeU` or `nodeV` are removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `nodeU` or `nodeV` are re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `nodeU` or `nodeV` is not an element of this network

public Set<E> edgesConnecting(N nodeU, N nodeV)

Returns a live view of the set of edges that each directly connect nodeU to nodeV.

In an undirected network, this is equal to edgesConnecting(nodeV, nodeU).

The resulting set of edges will be parallel (i.e. have equal incidentNodes(Object)). If this network does not allow parallel edges, the resulting set will contain at most one edge (equivalent to edgeConnecting(nodeU, nodeV).asSet()).

If either nodeU or nodeV are removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if nodeU or nodeV are re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if nodeU or nodeV is not an element of this network

edgesConnecting back to summary

edgesConnecting	back to summary
public Set<E> edgesConnecting(EndpointPair<N> endpoints) Returns a live view of the set of edges that each directly connect `endpoints` (in the order, if any, specified by `endpoints`). The resulting set of edges will be parallel (i.e. have equal `incidentNodes(Object)`). If this network does not `allow parallel edges`, the resulting set will contain at most one edge (equivalent to `edgeConnecting(endpoints).asSet()`). If this network is directed, `endpoints` must be ordered. If either element of `endpoints` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if either endpoint is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if either endpoint is not an element of this network if the endpoints are unordered and the network is directed Since 27.1

public Set<E> edgesConnecting(EndpointPair<N> endpoints)

Returns a live view of the set of edges that each directly connect endpoints (in the order, if any, specified by endpoints).

If this network is directed, endpoints must be ordered.

If either element of endpoints is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if either endpoint is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:

if either endpoint is not an element of this network
if the endpoints are unordered and the network is directed

Since

27.1

equals back to summary

equals	back to summary
public boolean equals(Object object) Returns `true` iff `object` is a `Network` that has the same elements and the same structural relationships as those in this network. Thus, two networks 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`. Every edge in A and B connects the same nodes in the same direction (if any). Network properties besides `directedness` do not affect equality. For example, two networks may be considered equal even if one allows parallel edges and the other doesn't. Additionally, the order in which nodes or edges are added to the network, and the order in which they are iterated over, are irrelevant. A reference implementation of this is provided by `AbstractNetwork#equals(Object)`. Annotations @Override

public boolean equals(Object object)

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

Thus, two networks 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.
Every edge in A and B connects the same nodes in the same direction (if any).

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

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

Annotations

@Override

hasEdgeConnecting back to summary

hasEdgeConnecting	back to summary
public boolean hasEdgeConnecting(N nodeU, N nodeV) Returns true if there is an edge that directly connects `nodeU` to `nodeV`. This is equivalent to `nodes().contains(nodeU) && successors(nodeU).contains(nodeV)`, and to `edgeConnectingOrNull(nodeU, nodeV) != null`. In an undirected network, this is equal to `hasEdgeConnecting(nodeV, nodeU)`. Since 23.0

public boolean hasEdgeConnecting(N nodeU, N nodeV)

Returns true if there is an edge that directly connects nodeU to nodeV. This is equivalent to nodes().contains(nodeU) && successors(nodeU).contains(nodeV), and to edgeConnectingOrNull(nodeU, nodeV) != null.

In an undirected network, this is equal to hasEdgeConnecting(nodeV, nodeU).

Since: 23.0

hasEdgeConnecting back to summary

hasEdgeConnecting	back to summary
public boolean hasEdgeConnecting(EndpointPair<N> endpoints) Returns true if there is an edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`). Unlike the other `EndpointPair`-accepting methods, this method does not throw if the endpoints are unordered and the network is directed; it simply returns `false`. This is for consistency with `Graph#hasEdgeConnecting(EndpointPair)` and `ValueGraph#hasEdgeConnecting(EndpointPair)`. Since 27.1

public boolean hasEdgeConnecting(EndpointPair<N> endpoints)

Returns true if there is an edge that directly connects endpoints (in the order, if any, specified by endpoints).

Unlike the other EndpointPair-accepting methods, this method does not throw if the endpoints are unordered and the network is directed; it simply returns false. This is for consistency with Graph#hasEdgeConnecting(EndpointPair) and ValueGraph#hasEdgeConnecting(EndpointPair).

Since: 27.1

hashCode back to summary

hashCode	back to summary
public int hashCode() Returns the hash code for this network. The hash code of a network is defined as the hash code of a map from each of its `edges` to their `incident nodes`. A reference implementation of this is provided by `AbstractNetwork#hashCode()`. Annotations @Override

public int hashCode()

Returns the hash code for this network. The hash code of a network is defined as the hash code of a map from each of its edges to their incident nodes.

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

Annotations

@Override

incidentEdges back to summary

incidentEdges	back to summary
public Set<E> incidentEdges(N node) Returns a live view of the edges whose `incident nodes` in this network include `node`. This is equal to the union of `inEdges(Object)` and `outEdges(Object)`. If `node` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `node` is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `node` is not an element of this network Since 24.0

public Set<E> incidentEdges(N node)

Returns a live view of the edges whose incident nodes in this network include node.

This is equal to the union of inEdges(Object) and outEdges(Object).

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if node is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if node is not an element of this network

Since

24.0

incidentNodes back to summary

incidentNodes	back to summary
public EndpointPair<N> incidentNodes(E edge) Returns the nodes which are the endpoints of `edge` in this network. Exceptions IllegalArgumentException: if `edge` is not an element of this network

public EndpointPair<N> incidentNodes(E edge)

Returns the nodes which are the endpoints of edge in this network.

Exceptions

IllegalArgumentException:: if edge is not an element of this network

inDegree back to summary

inDegree	back to summary
public int inDegree(N node) Returns the count of `node`'s `incoming edges` in a directed network. In an undirected network, returns the `degree(Object)`. If the count is greater than `Integer.MAX_VALUE`, returns `Integer.MAX_VALUE`. Exceptions IllegalArgumentException: if `node` is not an element of this network

public int inDegree(N node)

Returns the count of node's incoming edges in a directed network. In an undirected network, returns the degree(Object).

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

Exceptions

IllegalArgumentException:: if node is not an element of this network

inEdges back to summary

inEdges	back to summary
public Set<E> inEdges(N node) Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at `node`. In a directed network, an incoming edge's `EndpointPair#target()` equals `node`. In an undirected network, this is equivalent to `incidentEdges(Object)`. If `node` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `node` is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `node` is not an element of this network

public Set<E> inEdges(N node)

Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at node.

In a directed network, an incoming edge's EndpointPair#target() equals node.

In an undirected network, this is equivalent to incidentEdges(Object).

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if node is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if node is not an element of this network

isDirected	back to summary
public boolean isDirected() Returns true if the edges in this network are directed. Directed edges connect a `source node` to a `target node`, while undirected edges connect a pair of nodes to each other.

nodeOrder	back to summary
public ElementOrder<N> nodeOrder() Returns the order of iteration for the elements of `nodes()`.

nodes	back to summary
public Set<N> nodes() Returns all nodes in this network, in the order specified by `nodeOrder()`.

outDegree back to summary

outDegree	back to summary
public int outDegree(N node) Returns the count of `node`'s `outgoing edges` in a directed network. In an undirected network, returns the `degree(Object)`. If the count is greater than `Integer.MAX_VALUE`, returns `Integer.MAX_VALUE`. Exceptions IllegalArgumentException: if `node` is not an element of this network

public int outDegree(N node)

Returns the count of node's outgoing edges in a directed network. In an undirected network, returns the degree(Object).

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

Exceptions

IllegalArgumentException:: if node is not an element of this network

outEdges back to summary

outEdges	back to summary
public Set<E> outEdges(N node) Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from `node`. In a directed network, an outgoing edge's `EndpointPair#source()` equals `node`. In an undirected network, this is equivalent to `incidentEdges(Object)`. If `node` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `node` is re-added to the network after having been removed, `view`'s behavior is undefined Exceptions IllegalArgumentException: if `node` is not an element of this network

public Set<E> outEdges(N node)

Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from node.

In a directed network, an outgoing edge's EndpointPair#source() equals node.

In an undirected network, this is equivalent to incidentEdges(Object).

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if node is re-added to the network after having been removed, view's behavior is undefined

Exceptions

IllegalArgumentException:: if node is not an element of this network

predecessors back to summary

predecessors	back to summary
public Set<N> predecessors(N node) Redeclares com.google.common.graph.PredecessorsFunction.predecessors. Returns a live view of all nodes in this network adjacent to `node` which can be reached by traversing `node`'s incoming edges against the direction (if any) of the edge. In an undirected network, this is equivalent to `adjacentNodes(Object)`. If `node` is removed from the network after this method is called, the `Set` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way. Annotations @Override Exceptions IllegalArgumentException: if `node` is not an element of this network

public Set<N> predecessors(N node)

Redeclares com.google.common.graph.PredecessorsFunction.predecessors.

Returns a live view of all nodes in this network adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.

In an undirected network, this is equivalent to adjacentNodes(Object).

If node is removed from the network after this method is called, the `Set` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way.

Annotations

@Override

Exceptions

IllegalArgumentException:: if node is not an element of this network

successors back to summary

successors	back to summary
public Set<N> successors(N node) Redeclares com.google.common.graph.SuccessorsFunction.successors. Returns a live view of all nodes in this network adjacent to `node` which can be reached by traversing `node`'s outgoing edges in the direction (if any) of the edge. In an undirected network, this is equivalent to `adjacentNodes(Object)`. This is not the same as "all nodes reachable from `node` by following outgoing edges". For that functionality, see `Graphs#reachableNodes(Graph, Object)`. If `node` is removed from the network after this method is called, the `Set` `view` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way, with the following exceptions: `view.equals(view)` evaluates to `true` (but any other `equals()` expression involving `view` will throw) `hashCode()` does not throw if `node` is re-added to the network after having been removed, `view`'s behavior is undefined Annotations @Override Exceptions IllegalArgumentException: if `node` is not an element of this network

public Set<N> successors(N node)

Redeclares com.google.common.graph.SuccessorsFunction.successors.

Returns a live view of all nodes in this network adjacent to node which can be reached by traversing node's outgoing edges in the direction (if any) of the edge.

In an undirected network, this is equivalent to adjacentNodes(Object).

This is not the same as "all nodes reachable from node by following outgoing edges". For that functionality, see Graphs#reachableNodes(Graph, Object).

view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
hashCode() does not throw
if node is re-added to the network after having been removed, view's behavior is undefined

Annotations

@Override

Exceptions

IllegalArgumentException:: if node is not an element of this network

public Interface Network<N, E>

Capabilities

Building a `Network`

Additional documentation

Method Summary

Method Detail

public Interface Network<N, E>

Capabilities

Building a Network

Additional documentation

Method Summary

Method Detail

Building a `Network`