Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.graph.BaseGraph

Method Summary

Modifier and Type	Method and Description
public Set<N>	adjacentNodes(N node) Returns the nodes which have an incident edge in common with `node` in this graph.
public boolean	allowsSelfLoops() Returns true if this graph allows self-loops (edges that connect a node to itself).
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 Set<EndpointPair<N>>	edges() Returns all edges in this graph.
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 ElementOrder<N>	incidentEdgeOrder() Returns an `ElementOrder` that specifies the order of iteration for the elements of `edges()`, `adjacentNodes(Object)`, `predecessors(Object)`, `successors(Object)` and `incidentEdges(Object)`.
public Set<EndpointPair<N>>	incidentEdges(N node) Returns the edges in this graph whose endpoints include `node`.
public int	inDegree(N node) Returns the count of `node`'s incoming edges (equal to `predecessors(node).size()`) in a directed graph.
public boolean	isDirected() Returns true if the edges in this graph 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 graph, in the order specified by `nodeOrder()`.
public int	outDegree(N node) Returns the count of `node`'s outgoing edges (equal to `successors(node).size()`) in a directed graph.
public Set<N>	predecessors(N node) Redeclares com.google.common.graph.PredecessorsFunction.predecessors. Returns 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.
public Set<N>	successors(N node) Redeclares com.google.common.graph.SuccessorsFunction.successors. Returns 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.

Method Detail

adjacentNodes back to summary

adjacentNodes	back to summary
public Set<N> adjacentNodes(N node) Returns 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)`. Exceptions IllegalArgumentException: if `node` is not an element of this graph

public Set<N> adjacentNodes(N node)

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

Exceptions

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

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

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 graphs, this is equal to `inDegree(node) + outDegree(node)`. For undirected graphs, 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 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).

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

For undirected graphs, 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 graph

edges	back to summary
public Set<EndpointPair<N>> edges() Returns all edges in this graph.

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)`. In an undirected graph, 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).

In an undirected graph, 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`). This is equivalent to `edges().contains(endpoints)`. Unlike the other `EndpointPair`-accepting methods, this method does not throw if the endpoints are unordered; it simply returns false. This is for consistency with the behavior of `Collection#contains(Object)` (which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible with `edges().contains(endpoints)`. 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). This is equivalent to edges().contains(endpoints).

Unlike the other EndpointPair-accepting methods, this method does not throw if the endpoints are unordered; it simply returns false. This is for consistency with the behavior of Collection#contains(Object) (which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible with edges().contains(endpoints).

Since: 27.1

incidentEdgeOrder back to summary

incidentEdgeOrder	back to summary
public ElementOrder<N> incidentEdgeOrder() Returns an `ElementOrder` that specifies the order of iteration for the elements of `edges()`, `adjacentNodes(Object)`, `predecessors(Object)`, `successors(Object)` and `incidentEdges(Object)`. Since 29.0

public ElementOrder<N> incidentEdgeOrder()

Returns an ElementOrder that specifies the order of iteration for the elements of edges(), adjacentNodes(Object), predecessors(Object), successors(Object) and incidentEdges(Object).

Since: 29.0

incidentEdges back to summary

incidentEdges	back to summary
public Set<EndpointPair<N>> incidentEdges(N node) Returns the edges in this graph whose endpoints include `node`. This is equal to the union of incoming and outgoing edges. Exceptions IllegalArgumentException: if `node` is not an element of this graph Since 24.0

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

Returns the edges in this graph whose endpoints include node.

This is equal to the union of incoming and outgoing edges.

Exceptions

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

Since

24.0

inDegree back to summary

inDegree	back to summary
public int inDegree(N node) Returns the count of `node`'s incoming edges (equal to `predecessors(node).size()`) in a directed graph. In an undirected graph, 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 graph

public int inDegree(N node)

Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph. In an undirected graph, 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 graph

isDirected	back to summary
public boolean isDirected() Returns true if the edges in this graph 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 graph, 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 (equal to `successors(node).size()`) in a directed graph. In an undirected graph, 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 graph

public int outDegree(N node)

Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph. In an undirected graph, 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 graph

predecessors back to summary

predecessors	back to summary
public Set<N> predecessors(N node) Redeclares com.google.common.graph.PredecessorsFunction.predecessors. Returns 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. In an undirected graph, this is equivalent to `adjacentNodes(Object)`. Annotations @Override Exceptions IllegalArgumentException: if `node` is not an element of this graph

public Set<N> predecessors(N node)

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

Returns 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.

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

Annotations

@Override

Exceptions

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

successors back to summary

successors	back to summary
public Set<N> successors(N node) Redeclares com.google.common.graph.SuccessorsFunction.successors. Returns 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. In an undirected graph, 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)`. Annotations @Override Exceptions IllegalArgumentException: if `node` is not an element of this graph

public Set<N> successors(N node)

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

Returns 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.

In an undirected graph, 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).

Annotations

@Override

Exceptions

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

pack-priv Interface BaseGraph<N>

Method Summary

Method Detail