Package org.jgrapht.alg

Class DirectedNeighborIndex<V,​E>

  • All Implemented Interfaces:
    java.util.EventListener, GraphListener<V,​E>, VertexSetListener<V>
    public class DirectedNeighborIndex<V,​E>
extends java.lang.Object
implements GraphListener<V,​E>
    Maintains a cache of each vertex's neighbors. While lists of neighbors can be obtained from Graphs, they are re-calculated at each invocation by walking a vertex's incident edges, which becomes inordinately expensive when performed often.

    A vertex's neighbors are cached the first time they are asked for (i.e. the index is built on demand). The index will only be updated automatically if it is added to the associated graph as a listener. If it is added as a listener to a graph other than the one it indexes, results are undefined.

    Since:
    Dec 13, 2005
    Author:
    Charles Fry

    • Constructor Detail

      • DirectedNeighborIndex

        public DirectedNeighborIndex​(DirectedGraph<V,​E> g)
        Creates a neighbor index for the specified directed graph.
        Parameters:
        g - the graph for which a neighbor index is to be created.

    • Method Detail

      • predecessorsOf

        public java.util.Set<V> predecessorsOf​(V v)
        Returns the set of vertices which are the predecessors of a specified vertex. The returned set is backed by the index, and will be updated when the graph changes as long as the index has been added as a listener to the graph.
        Parameters:
        v - the vertex whose predecessors are desired
        Returns:
        all unique predecessors of the specified vertex

      • predecessorListOf

        public java.util.List<V> predecessorListOf​(V v)
        Returns the set of vertices which are the predecessors of a specified vertex. If the graph is a multigraph, vertices may appear more than once in the returned list. Because a list of predecessors can not be efficiently maintained, it is reconstructed on every invocation by duplicating entries in the neighbor set. It is thus more efficient to use predecessorsOf(Object) unless duplicate neighbors are required.
        Parameters:
        v - the vertex whose predecessors are desired
        Returns:
        all predecessors of the specified vertex

      • successorsOf

        public java.util.Set<V> successorsOf​(V v)
        Returns the set of vertices which are the successors of a specified vertex. The returned set is backed by the index, and will be updated when the graph changes as long as the index has been added as a listener to the graph.
        Parameters:
        v - the vertex whose successors are desired
        Returns:
        all unique successors of the specified vertex

      • successorListOf

        public java.util.List<V> successorListOf​(V v)
        Returns the set of vertices which are the successors of a specified vertex. If the graph is a multigraph, vertices may appear more than once in the returned list. Because a list of successors can not be efficiently maintained, it is reconstructed on every invocation by duplicating entries in the neighbor set. It is thus more efficient to use successorsOf(Object) unless duplicate neighbors are required.
        Parameters:
        v - the vertex whose successors are desired
        Returns:
        all successors of the specified vertex