Class AbstractNetwork<N,E>
- Type Parameters:
N- Node parameter typeE- Edge parameter type
- All Implemented Interfaces:
Network<N,,E> PredecessorsFunction<N>,SuccessorsFunction<N>
- Direct Known Subclasses:
ForwardingNetwork,StandardNetwork
Network. It is recommended to extend
this class rather than implement Network directly.
The methods implemented in this class should not be overridden unless the subclass admits a more efficient implementation.
- Since:
- 20.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadjacentEdges(E edge) Returns the edges which have anincident nodein common withedge.asGraph()Returns a live view of this network as aGraph.connectedPredicate(N nodePresent, N nodeToCheck) intReturns the count ofnode'sincident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode).edgeConnecting(EndpointPair<N> endpoints) Returns the single edge that directly connectsendpoints(in the order, if any, specified byendpoints), if one is present, orOptional.empty()if no such edge exists.edgeConnecting(N nodeU, N nodeV) Returns the single edge that directly connectsnodeUtonodeV, if one is present, orOptional.empty()if no such edge exists.edgeConnectingOrNull(EndpointPair<N> endpoints) Returns the single edge that directly connectsendpoints(in the order, if any, specified byendpoints), if one is present, ornullif no such edge exists.edgeConnectingOrNull(N nodeU, N nodeV) Returns the single edge that directly connectsnodeUtonodeV, if one is present, ornullif no such edge exists.private static <N,E> Map<E, EndpointPair<N>> edgeIncidentNodesMap(Network<N, E> network) edgesConnecting(EndpointPair<N> endpoints) Returns the set of edges that each directly connectendpoints(in the order, if any, specified byendpoints).edgesConnecting(N nodeU, N nodeV) Returns the set of edges that each directly connectnodeUtonodeV.final booleanReturnstrueiffobjectis aNetworkthat has the same elements and the same structural relationships as those in this network.booleanhasEdgeConnecting(EndpointPair<N> endpoints) Returns true if there is an edge that directly connectsendpoints(in the order, if any, specified byendpoints).booleanhasEdgeConnecting(N nodeU, N nodeV) Returns true if there is an edge that directly connectsnodeUtonodeV.final inthashCode()Returns the hash code for this network.intReturns the count ofnode'sincoming edgesin a directed network.protected final booleanisOrderingCompatible(EndpointPair<?> endpoints) intReturns the count ofnode'soutgoing edgesin a directed network.toString()Returns a string representation of this network.protected final voidvalidateEndpoints(EndpointPair<?> endpoints) Throws an IllegalArgumentException if the ordering ofendpointsis not compatible with the directionality of this graph.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.graph.Network
adjacentNodes, allowsParallelEdges, allowsSelfLoops, edgeOrder, edges, incidentEdges, incidentNodes, inEdges, isDirected, nodeOrder, nodes, outEdges, predecessors, successors
-
Constructor Details
-
AbstractNetwork
public AbstractNetwork()
-
-
Method Details
-
asGraph
Description copied from interface:NetworkReturns a live view of this network as aGraph. The resultingGraphwill have an edge connecting node A to node B if thisNetworkhas 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, theNetwork.degree(Object)of a node in theGraphview may be less than the degree of the same node in thisNetwork. -
degree
Description copied from interface:NetworkReturns the count ofnode'sincident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode).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 tonode).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE. -
inDegree
Description copied from interface:NetworkReturns the count ofnode'sincoming edgesin a directed network. In an undirected network, returns theNetwork.degree(Object).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE. -
outDegree
Description copied from interface:NetworkReturns the count ofnode'soutgoing edgesin a directed network. In an undirected network, returns theNetwork.degree(Object).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE. -
adjacentEdges
Description copied from interface:NetworkReturns the edges which have anincident nodein common withedge. An edge is not considered adjacent to itself.- Specified by:
adjacentEdgesin interfaceNetwork<N,E>
-
edgesConnecting
Description copied from interface:NetworkReturns the set of edges that each directly connectnodeUtonodeV.In an undirected network, this is equal to
edgesConnecting(nodeV, nodeU).The resulting set of edges will be parallel (i.e. have equal
Network.incidentNodes(Object). If this network does notallow parallel edges, the resulting set will contain at most one edge (equivalent toedgeConnecting(nodeU, nodeV).asSet()).- Specified by:
edgesConnectingin interfaceNetwork<N,E>
-
edgesConnecting
Description copied from interface:NetworkReturns the set of edges that each directly connectendpoints(in the order, if any, specified byendpoints).The resulting set of edges will be parallel (i.e. have equal
Network.incidentNodes(Object). If this network does notallow parallel edges, the resulting set will contain at most one edge (equivalent toedgeConnecting(endpoints).asSet()).If this network is directed,
endpointsmust be ordered.- Specified by:
edgesConnectingin interfaceNetwork<N,E>
-
connectedPredicate
-
edgeConnecting
Description copied from interface:NetworkReturns the single edge that directly connectsnodeUtonodeV, if one is present, orOptional.empty()if no such edge exists.In an undirected network, this is equal to
edgeConnecting(nodeV, nodeU).- Specified by:
edgeConnectingin interfaceNetwork<N,E>
-
edgeConnecting
Description copied from interface:NetworkReturns the single edge that directly connectsendpoints(in the order, if any, specified byendpoints), if one is present, orOptional.empty()if no such edge exists.If this graph is directed, the endpoints must be ordered.
- Specified by:
edgeConnectingin interfaceNetwork<N,E>
-
edgeConnectingOrNull
Description copied from interface:NetworkReturns the single edge that directly connectsnodeUtonodeV, if one is present, ornullif no such edge exists.In an undirected network, this is equal to
edgeConnectingOrNull(nodeV, nodeU).- Specified by:
edgeConnectingOrNullin interfaceNetwork<N,E>
-
edgeConnectingOrNull
Description copied from interface:NetworkReturns the single edge that directly connectsendpoints(in the order, if any, specified byendpoints), if one is present, ornullif no such edge exists.If this graph is directed, the endpoints must be ordered.
- Specified by:
edgeConnectingOrNullin interfaceNetwork<N,E>
-
hasEdgeConnecting
Description copied from interface:NetworkReturns true if there is an edge that directly connectsnodeUtonodeV. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV), and toedgeConnectingOrNull(nodeU, nodeV) != null.In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU).- Specified by:
hasEdgeConnectingin interfaceNetwork<N,E>
-
hasEdgeConnecting
Description copied from interface:NetworkReturns true if there is an edge that directly connectsendpoints(in the order, if any, specified byendpoints).Unlike the other
EndpointPair-accepting methods, this method does not throw if the endpoints are unordered and the graph is directed; it simply returnsfalse. This is for consistency withGraph.hasEdgeConnecting(EndpointPair)andValueGraph.hasEdgeConnecting(EndpointPair).- Specified by:
hasEdgeConnectingin interfaceNetwork<N,E>
-
validateEndpoints
Throws an IllegalArgumentException if the ordering ofendpointsis not compatible with the directionality of this graph. -
isOrderingCompatible
-
equals
Description copied from interface:NetworkReturnstrueiffobjectis aNetworkthat 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
directednessdo 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
equals(Object). - A and B have equal
-
hashCode
public final int hashCode()Description copied from interface:NetworkReturns the hash code for this network. The hash code of a network is defined as the hash code of a map from each of itsedgesto theirincident nodes.A reference implementation of this is provided by
hashCode(). -
toString
Returns a string representation of this network. -
edgeIncidentNodesMap
-