Class ConfigurableNetwork<N,​E>

  • Type Parameters:
    N - Node parameter type
    E - Edge parameter type
    All Implemented Interfaces:
    Network<N,​E>, PredecessorsFunction<N>, SuccessorsFunction<N>
    Direct Known Subclasses:
    ConfigurableMutableNetwork, ImmutableNetwork

    class ConfigurableNetwork<N,​E>
    extends AbstractNetwork<N,​E>
    Configurable implementation of Network that supports the options supplied by NetworkBuilder.

    This class maintains a map of nodes to NetworkConnections. This class also maintains a map of edges to reference nodes. The reference node is defined to be the edge's source node on directed graphs, and an arbitrary endpoint of the edge on undirected graphs.

    Collection-returning accessors return unmodifiable views: the view returned will reflect changes to the graph (if the graph is mutable) but may not be modified by the user.

    The time complexity of all collection-returning accessors is O(1), since views are returned.

    • Field Detail

      • isDirected

        private final boolean isDirected
      • allowsParallelEdges

        private final boolean allowsParallelEdges
      • allowsSelfLoops

        private final boolean allowsSelfLoops
    • Constructor Detail

      • ConfigurableNetwork

        ConfigurableNetwork​(NetworkBuilder<? super N,​? super E> builder)
        Constructs a graph with the properties specified in builder.
      • ConfigurableNetwork

        ConfigurableNetwork​(NetworkBuilder<? super N,​? super E> builder,
                            java.util.Map<N,​NetworkConnections<N,​E>> nodeConnections,
                            java.util.Map<E,​N> edgeToReferenceNode)
        Constructs a graph with the properties specified in builder, initialized with the given node and edge maps.
    • Method Detail

      • nodes

        public java.util.Set<N> nodes()
        Description copied from interface: Network
        Returns all nodes in this network, in the order specified by Network.nodeOrder().
      • edges

        public java.util.Set<E> edges()
        Description copied from interface: Network
        Returns all edges in this network, in the order specified by Network.edgeOrder().
      • isDirected

        public boolean isDirected()
        Description copied from interface: Network
        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.
      • allowsParallelEdges

        public boolean allowsParallelEdges()
        Description copied from interface: Network
        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

        public boolean allowsSelfLoops()
        Description copied from interface: Network
        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.
      • incidentEdges

        public java.util.Set<E> incidentEdges​(N node)
        Description copied from interface: Network
        Returns the edges whose incident nodes in this network include node.
      • incidentNodes

        public EndpointPair<N> incidentNodes​(E edge)
        Description copied from interface: Network
        Returns the nodes which are the endpoints of edge in this network.
      • adjacentNodes

        public java.util.Set<N> adjacentNodes​(N node)
        Description copied from interface: Network
        Returns the nodes which have an incident edge in common with node in this network.
      • edgesConnecting

        public java.util.Set<E> edgesConnecting​(N nodeU,
                                                N nodeV)
        Description copied from interface: Network
        Returns the set of edges directly connecting 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 Network.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()).

        Specified by:
        edgesConnecting in interface Network<N,​E>
        Overrides:
        edgesConnecting in class AbstractNetwork<N,​E>
      • inEdges

        public java.util.Set<E> inEdges​(N node)
        Description copied from interface: Network
        Returns 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 Network.incidentEdges(Object).

      • outEdges

        public java.util.Set<E> outEdges​(N node)
        Description copied from interface: Network
        Returns 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 Network.incidentEdges(Object).

      • predecessors

        public java.util.Set<N> predecessors​(N node)
        Description copied from interface: Network
        Returns 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 Network.adjacentNodes(Object).

      • successors

        public java.util.Set<N> successors​(N node)
        Description copied from interface: Network
        Returns 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 Network.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).

      • checkedReferenceNode

        protected final N checkedReferenceNode​(E edge)
      • containsNode

        protected final boolean containsNode​(N node)
      • containsEdge

        protected final boolean containsEdge​(E edge)