Module org.jgrapht.unimi.dsi
Package org.jgrapht.sux4j

Class SuccinctUndirectedGraph

java.lang.Object
org.jgrapht.graph.AbstractGraph<Integer,E>
org.jgrapht.sux4j.AbstractSuccinctGraph<E>
org.jgrapht.sux4j.AbstractSuccinctUndirectedGraph<it.unimi.dsi.fastutil.ints.IntIntSortedPair>
org.jgrapht.sux4j.SuccinctUndirectedGraph
All Implemented Interfaces:
Serializable, Graph<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
public class SuccinctUndirectedGraph extends AbstractSuccinctUndirectedGraph<it.unimi.dsi.fastutil.ints.IntIntSortedPair> implements Serializable
An immutable undirected graph with IntIntSortedPair edges represented using quasi-succinct data structures.

The graph representation of this implementation uses the Elias–Fano representation of monotone sequences to represent the positions of ones in the (linearized) adjacency matrix of the graph. Edges are represented by instances of IntIntSortedPair. Instances are serializable and thread safe.

If the vertex set is compact (i.e., vertices are numbered from 0 consecutively), space usage will be close to the information-theoretical lower bound (typically, a few times smaller than a SparseIntUndirectedGraph).

All accessors are very fast. Adjacency tests are very fast and happen in almost constant time.

SuccinctIntUndirectedGraph is a much slower implementation with a similar footprint using Integer as edge type. Please read the class documentation for more information.

For convenience, and as a compromise with the approach of SuccinctIntUndirectedGraph, this class provides methods getEdgeFromIndex() and getIndexFromEdge() that map bijectively the edge set into a contiguous set of longs.

Author:
Sebastiano Vigna
See Also:

  • Constructor Details

    • SuccinctUndirectedGraph

      public SuccinctUndirectedGraph(Graph<Integer,E> graph)
      Creates a new immutable succinct undirected graph from a given undirected graph.
      Type Parameters:
      E - the graph edge type
      Parameters:
      graph - an undirected graph: for good results, vertices should be numbered consecutively starting from 0.

    • SuccinctUndirectedGraph

      public SuccinctUndirectedGraph(int numVertices, List<Pair<Integer,Integer>> edges)
      Creates a new immutable succinct undirected graph from an edge list.

      This constructor just builds a SparseIntUndirectedGraph and delegates to the main constructor.

      Parameters:
      numVertices - the number of vertices.
      edges - the edge list.
      See Also:

  • Method Details

    • containsEdge

      public boolean containsEdge(it.unimi.dsi.fastutil.ints.IntIntSortedPair 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      e - edge whose presence in this graph is to be tested.
      Returns:
      true if this graph contains the specified edge.

    • edgeSet

      public Set<it.unimi.dsi.fastutil.ints.IntIntSortedPair> 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Returns:
      a set of the edges contained in this graph.

    • degreeOf

      public int degreeOf(Integer 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      vertex - vertex whose degree is to be calculated.
      Returns:
      the degree of the specified vertex.

    • edgesOf

      public Set<it.unimi.dsi.fastutil.ints.IntIntSortedPair> edgesOf(Integer 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      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.

    • incomingEdgesOf

      public Set<it.unimi.dsi.fastutil.ints.IntIntSortedPair> incomingEdgesOf(Integer 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      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.

    • outgoingEdgesOf

      public Set<it.unimi.dsi.fastutil.ints.IntIntSortedPair> outgoingEdgesOf(Integer 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      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.

    • getEdgeSource

      public Integer getEdgeSource(it.unimi.dsi.fastutil.ints.IntIntSortedPair 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      e - edge of interest
      Returns:
      source vertex

    • getEdgeTarget

      public Integer getEdgeTarget(it.unimi.dsi.fastutil.ints.IntIntSortedPair 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      e - edge of interest
      Returns:
      target vertex

    • getIndexFromEdge

      public long getIndexFromEdge(it.unimi.dsi.fastutil.ints.IntIntSortedPair e)
      Returns the index associated with the given edge.
      Parameters:
      e - an edge of the graph.
      Returns:
      the index associated with the edge, or −1 if the edge is not part of the graph.
      See Also:

    • getEdgeFromIndex

      public it.unimi.dsi.fastutil.ints.IntIntSortedPair getEdgeFromIndex(long i)
      Returns the edge with given index.
      Parameters:
      i - an index between 0 (included) and the number of edges (excluded).
      Returns:
      the pair with index i.
      See Also:

    • getEdge

      public it.unimi.dsi.fastutil.ints.IntIntSortedPair getEdge(Integer sourceVertex, Integer 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<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      sourceVertex - source vertex of the edge.
      targetVertex - target vertex of the edge.
      Returns:
      an edge connecting source vertex to target vertex.

    • containsEdge

      public boolean containsEdge(Integer sourceVertex, Integer targetVertex)
      Description copied from interface: Graph
      Returns true if and only if this graph contains an edge going from the source vertex to the target vertex. In undirected graphs the same result is obtained when source and target are inverted. If any of the specified vertices does not exist in the graph, or if is null, returns false.
      Specified by:
      containsEdge in interface Graph<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Overrides:
      containsEdge in class AbstractGraph<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Parameters:
      sourceVertex - source vertex of the edge.
      targetVertex - target vertex of the edge.
      Returns:
      true if this graph contains the specified edge.
      See Also:

    • iterables

      public GraphIterables<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair> iterables()
      Description copied from interface: Graph
      Access the graph using the GraphIterables interface. This allows accessing graphs without the restrictions imposed by 32-bit arithmetic. Moreover, graph implementations are free to implement this interface without explicitly materializing intermediate results.
      Specified by:
      iterables in interface Graph<Integer,it.unimi.dsi.fastutil.ints.IntIntSortedPair>
      Returns:
      the graph iterables