Module org.jgrapht.guava
Package org.jgrapht.graph.guava

Class BaseValueGraphAdapter<V,​W,​VG extends com.google.common.graph.ValueGraph<V,​W>>

  • Type Parameters:
    V - the graph vertex type
    W - the value type
    VG - type of the underlying Guava's value graph
    All Implemented Interfaces:
    Serializable, Cloneable, Graph<V,​com.google.common.graph.EndpointPair<V>>
    Direct Known Subclasses:
    ImmutableValueGraphAdapter, MutableValueGraphAdapter
    public abstract class BaseValueGraphAdapter<V,​W,​VG extends com.google.common.graph.ValueGraph<V,​W>>
extends AbstractGraph<V,​com.google.common.graph.EndpointPair<V>>
implements Graph<V,​com.google.common.graph.EndpointPair<V>>, Cloneable, Serializable
    A base abstract implementation for the graph adapter class using Guava's ValueGraph. This is a helper class in order to support both mutable and immutable value graphs.
    Author:
    Dimitrios Michail
    See Also:
    Serialized Form

    • Field Detail

      • unmodifiableVertexSet

        protected transient Set<V> unmodifiableVertexSet

      • unmodifiableEdgeSet

        protected transient Set<com.google.common.graph.EndpointPair<V>> unmodifiableEdgeSet

      • vertexSupplier

        protected Supplier<V> vertexSupplier

      • edgeSupplier

        protected Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier

      • valueGraph

        protected transient VG extends com.google.common.graph.ValueGraph<V,​W> valueGraph

      • vertexOrder

        protected transient org.jgrapht.graph.guava.ElementOrder<V> vertexOrder

    • Constructor Detail

      • BaseValueGraphAdapter

        public BaseValueGraphAdapter​(VG valueGraph,
                             ToDoubleFunction<W> valueConverter)
        Create a new adapter.
        Parameters:
        valueGraph - the mutable value graph
        valueConverter - a function that converts a value to a double
        Throws:
        NullPointerException - if either one of valueGraph or valueConverter is null

      • BaseValueGraphAdapter

        public BaseValueGraphAdapter​(VG valueGraph,
                             ToDoubleFunction<W> valueConverter,
                             Supplier<V> vertexSupplier,
                             Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)
        Create a new adapter.
        Parameters:
        valueGraph - the mutable value graph
        valueConverter - a function that converts a value to a double
        vertexSupplier - the vertex supplier
        edgeSupplier - the edge supplier
        Throws:
        NullPointerException - if either one of valueGraph or valueConverter is null

      • BaseValueGraphAdapter

        public BaseValueGraphAdapter​(VG valueGraph,
                             ToDoubleFunction<W> valueConverter,
                             Supplier<V> vertexSupplier,
                             Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier,
                             ElementOrderMethod<V> vertexOrderMethod)
        Create a new adapter.
        Parameters:
        valueGraph - the mutable value graph
        valueConverter - a function that converts a value to a double
        vertexSupplier - the vertex supplier
        edgeSupplier - the edge supplier
        vertexOrderMethod - the method used to ensure a total order of the graph vertices. This is required in order to make edge source/targets be consistent.
        Throws:
        IllegalArgumentException - if the supplied vertexOrderMethod cannot be used to create a vertex order
        NullPointerException - if any one of valueGraph, valueConverter, or vertexOrderMethod is null

    • Method Detail

      • getVertexSupplier

        public Supplier<V> getVertexSupplier()
        Description copied from interface: Graph
        Return the vertex supplier that the graph uses whenever it needs to create new vertices.

        A graph uses the vertex supplier to create new vertex objects whenever a user calls method Graph.addVertex(). Users can also create the vertex in user code and then use method Graph.addVertex(Object) to add the vertex.

        In contrast with the Supplier interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graph v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v).

        Care must also be taken when interchanging calls to methods Graph.addVertex(Object) and Graph.addVertex(). In such a case the user must make sure never to add vertices in the graph using method Graph.addVertex(Object), which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into an IllegalArgumentException when calling method Graph.addVertex().

        Specified by:
        getVertexSupplier in interface Graph<V,​W>
        Returns:
        the vertex supplier or null if the graph has no such supplier

      • setVertexSupplier

        public void setVertexSupplier​(Supplier<V> vertexSupplier)
        Set the vertex supplier that the graph uses whenever it needs to create new vertices.

        A graph uses the vertex supplier to create new vertex objects whenever a user calls method Graph.addVertex(). Users can also create the vertex in user code and then use method Graph.addVertex(Object) to add the vertex.

        In contrast with the Supplier interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graph v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v).

        Parameters:
        vertexSupplier - the vertex supplier

      • getEdgeSupplier

        public Supplier<com.google.common.graph.EndpointPair<V>> getEdgeSupplier()
        Description copied from interface: Graph
        Return the edge supplier that the graph uses whenever it needs to create new edges.

        A graph uses the edge supplier to create new edge objects whenever a user calls method Graph.addEdge(Object, Object). Users can also create the edge in user code and then use method Graph.addEdge(Object, Object, Object) to add the edge.

        In contrast with the Supplier interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graph e must not be equal to any other edge in the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e).

        Specified by:
        getEdgeSupplier in interface Graph<V,​W>
        Returns:
        the edge supplier null if the graph has no such supplier

      • setEdgeSupplier

        public void setEdgeSupplier​(Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)
        Set the edge supplier that the graph uses whenever it needs to create new edges.

        A graph uses the edge supplier to create new edge objects whenever a user calls method Graph.addEdge(Object, Object). Users can also create the edge in user code and then use method Graph.addEdge(Object, Object, Object) to add the edge.

        In contrast with the Supplier interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graph e must not be equal to any other edge in the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e).

        Parameters:
        edgeSupplier - the edge supplier

      • getEdge

        public com.google.common.graph.EndpointPair<V> getEdge​(V sourceVertex,
                                                       V targetVertex)
        Description copied from interface: Graph
        Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returns null. If any of the specified vertices is null returns null

        In undirected graphs, the returned edge may have its source and target vertices in the opposite order.

        Specified by:
        getEdge in interface Graph<V,​W>
        Parameters:
        sourceVertex - source vertex of the edge.
        targetVertex - target vertex of the edge.
        Returns:
        an edge connecting source vertex to target vertex.

      • vertexSet

        public Set<V> vertexSet()
        Description copied from interface: Graph
        Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

        The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

        Specified by:
        vertexSet in interface Graph<V,​W>
        Returns:
        a set view of the vertices contained in this graph.

      • getEdgeSource

        public V getEdgeSource​(com.google.common.graph.EndpointPair<V> e)
        Description copied from interface: Graph
        Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).
        Specified by:
        getEdgeSource in interface Graph<V,​W>
        Parameters:
        e - edge of interest
        Returns:
        source vertex

      • getEdgeTarget

        public V getEdgeTarget​(com.google.common.graph.EndpointPair<V> e)
        Description copied from interface: Graph
        Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).
        Specified by:
        getEdgeTarget in interface Graph<V,​W>
        Parameters:
        e - edge of interest
        Returns:
        target vertex

      • getType

        public GraphType getType()
        Description copied from interface: Graph
        Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, self-loops, multiple (parallel) edges, weights, etc.
        Specified by:
        getType in interface Graph<V,​W>
        Returns:
        the graph type

      • containsEdge

        public boolean containsEdge​(com.google.common.graph.EndpointPair<V> e)
        Description copied from interface: Graph
        Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edge e2 such that e.equals(e2). If the specified edge is null returns false.
        Specified by:
        containsEdge in interface Graph<V,​W>
        Parameters:
        e - edge whose presence in this graph is to be tested.
        Returns:
        true if this graph contains the specified edge.

      • containsVertex

        public boolean containsVertex​(V v)
        Description copied from interface: Graph
        Returns true if this graph contains the specified vertex. More formally, returns true if and only if this graph contains a vertex u such that u.equals(v). If the specified vertex is null returns false.
        Specified by:
        containsVertex in interface Graph<V,​W>
        Parameters:
        v - vertex whose presence in this graph is to be tested.
        Returns:
        true if this graph contains the specified vertex.

      • edgeSet

        public Set<com.google.common.graph.EndpointPair<V>> edgeSet()
        Description copied from interface: Graph
        Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

        The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

        Specified by:
        edgeSet in interface Graph<V,​W>
        Returns:
        a set of the edges contained in this graph.

      • degreeOf

        public int degreeOf​(V vertex)
        Description copied from interface: Graph
        Returns the degree of the specified vertex.

        A degree of a vertex in an undirected graph is the number of edges touching that vertex. Edges with same source and target vertices (self-loops) are counted twice.

        In directed graphs this method returns the sum of the "in degree" and the "out degree".

        Specified by:
        degreeOf in interface Graph<V,​W>
        Parameters:
        vertex - vertex whose degree is to be calculated.
        Returns:
        the degree of the specified vertex.

      • edgesOf

        public Set<com.google.common.graph.EndpointPair<V>> edgesOf​(V vertex)
        Description copied from interface: Graph
        Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.
        Specified by:
        edgesOf in interface Graph<V,​W>
        Parameters:
        vertex - the vertex for which a set of touching edges is to be returned.
        Returns:
        a set of all edges touching the specified vertex.

      • inDegreeOf

        public int inDegreeOf​(V vertex)
        Description copied from interface: Graph
        Returns the "in degree" of the specified vertex.

        The "in degree" of a vertex in a directed graph is the number of inward directed edges from that vertex. See http://mathworld.wolfram.com/Indegree.html.

        In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

        Specified by:
        inDegreeOf in interface Graph<V,​W>
        Parameters:
        vertex - vertex whose degree is to be calculated.
        Returns:
        the degree of the specified vertex.

      • incomingEdgesOf

        public Set<com.google.common.graph.EndpointPair<V>> incomingEdgesOf​(V vertex)
        Description copied from interface: Graph
        Returns a set of all edges incoming into the specified vertex.

        In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

        Specified by:
        incomingEdgesOf in interface Graph<V,​W>
        Parameters:
        vertex - the vertex for which the list of incoming edges to be returned.
        Returns:
        a set of all edges incoming into the specified vertex.

      • outDegreeOf

        public int outDegreeOf​(V vertex)
        Description copied from interface: Graph
        Returns the "out degree" of the specified vertex.

        The "out degree" of a vertex in a directed graph is the number of outward directed edges from that vertex. See http://mathworld.wolfram.com/Outdegree.html.

        In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

        Specified by:
        outDegreeOf in interface Graph<V,​W>
        Parameters:
        vertex - vertex whose degree is to be calculated.
        Returns:
        the degree of the specified vertex.

      • outgoingEdgesOf

        public Set<com.google.common.graph.EndpointPair<V>> outgoingEdgesOf​(V vertex)
        Description copied from interface: Graph
        Returns a set of all edges outgoing from the specified vertex.

        In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

        Specified by:
        outgoingEdgesOf in interface Graph<V,​W>
        Parameters:
        vertex - the vertex for which the list of outgoing edges to be returned.
        Returns:
        a set of all edges outgoing from the specified vertex.

      • getEdgeWeight

        public double getEdgeWeight​(com.google.common.graph.EndpointPair<V> e)
        Description copied from interface: Graph
        Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined by Graph.DEFAULT_EDGE_WEIGHT), allowing weighted-graph algorithms to apply to them when meaningful.
        Specified by:
        getEdgeWeight in interface Graph<V,​W>
        Parameters:
        e - edge of interest
        Returns:
        edge weight
        Throws:
        IllegalArgumentException - if the specified edge is not in this graph
        NullPointerException - if argument is null

      • getAllEdges

        public Set<com.google.common.graph.EndpointPair<V>> getAllEdges​(V sourceVertex,
                                                                V targetVertex)
        Description copied from interface: Graph
        Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or is null, returns null. If both vertices exist but no edges found, returns an empty set.

        In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned set is either singleton set or empty set.

        Specified by:
        getAllEdges in interface Graph<V,​W>
        Parameters:
        sourceVertex - source vertex of the edge.
        targetVertex - target vertex of the edge.
        Returns:
        a set of all edges connecting source vertex to target vertex.

      • createVertexOrder

        protected org.jgrapht.graph.guava.ElementOrder<V> createVertexOrder​(ElementOrderMethod<V> vertexOrderMethod)
        Create the internal vertex order implementation.
        Parameters:
        vertexOrderMethod - method to use
        Returns:
        the vertex order
        Throws:
        IllegalArgumentException - if the supplied method cannot be used to create a vertex order