Interface NetworkConnections<N,E>

Type Parameters:
N - Node parameter type
E - Edge parameter type
All Known Implementing Classes:
AbstractDirectedNetworkConnections, AbstractUndirectedNetworkConnections, DirectedMultiNetworkConnections, DirectedNetworkConnections, UndirectedMultiNetworkConnections, UndirectedNetworkConnections

interface NetworkConnections<N,E>
An interface for representing and manipulating an origin node's adjacent nodes and incident edges in a Network.
  • Method Details

    • adjacentNodes

      Set<N> adjacentNodes()
    • predecessors

      Set<N> predecessors()
    • successors

      Set<N> successors()
    • incidentEdges

      Set<E> incidentEdges()
    • inEdges

      Set<E> inEdges()
    • outEdges

      Set<E> outEdges()
    • edgesConnecting

      Set<E> edgesConnecting(N node)
      Returns the set of edges connecting the origin node to node. For networks without parallel edges, this set cannot be of size greater than one.
    • adjacentNode

      N adjacentNode(E edge)
      Returns the node that is adjacent to the origin node along edge.

      In the directed case, edge is assumed to be an outgoing edge.

    • removeInEdge

      @CheckForNull N removeInEdge(E edge, boolean isSelfLoop)
      Remove edge from the set of incoming edges. Returns the former predecessor node.

      In the undirected case, returns null if isSelfLoop is true.

    • removeOutEdge

      N removeOutEdge(E edge)
      Remove edge from the set of outgoing edges. Returns the former successor node.
    • addInEdge

      void addInEdge(E edge, N node, boolean isSelfLoop)
      Add edge to the set of incoming edges. Implicitly adds node as a predecessor.
    • addOutEdge

      void addOutEdge(E edge, N node)
      Add edge to the set of outgoing edges. Implicitly adds node as a successor.