Module org.jgrapht.core
Package org.jgrapht.alg.util

Class VertexDegreeComparator<V,E>

java.lang.Object
org.jgrapht.alg.util.VertexDegreeComparator<V,E>
Type Parameters:
V - the graph vertex type
E - the graph edge type
All Implemented Interfaces:
Comparator<V>
public class VertexDegreeComparator<V,E> extends Object implements Comparator<V>
Compares two vertices based on their degree.

Used by greedy algorithms that need to sort vertices by their degree. Two vertices are considered equal if their degrees are equal.

Author:
Linda Buisman

  • Constructor Details

    • VertexDegreeComparator

      @Deprecated(forRemoval=true, since="1.5.1") public VertexDegreeComparator(Graph<V,E> g)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use of(Graph)
      Creates a comparator for comparing the degrees of vertices in the specified graph. The comparator compares in ascending order of degrees (lowest first).
      Parameters:
      g - graph with respect to which the degree is calculated.

    • VertexDegreeComparator

      @Deprecated(forRemoval=true, since="1.5.1") public VertexDegreeComparator(Graph<V,E> g, VertexDegreeComparator.Order order)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use of(Graph) for ascending order or reverse the comparator for descending order.
      Creates a comparator for comparing the degrees of vertices in the specified graph.
      Parameters:
      g - graph with respect to which the degree is calculated.
      order - order in which the vertices are sorted (ascending or descending)

  • Method Details

    • of

      public static <V> Comparator<V> of(Graph<V,?> g)
      Returns a Comparator that compares vertices by their degrees in the specified graph.

      The comparator compares in ascending order of degrees (lower degree first). To obtain a comparator that compares in descending order call Comparator.reversed() on the returned comparator.

      Type Parameters:
      V - the graph vertex type
      Parameters:
      g - graph with respect to which the degree is calculated.
      Returns:
      a Comparator to compare vertices by their degree in ascending order

    • compare

      @Deprecated(forRemoval=true, since="1.5.1") public int compare(V v1, V v2)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use of(Graph)
      Compare the degrees of v1 and v2, taking into account whether ascending or descending order is used.
      Specified by:
      compare in interface Comparator<V>
      Parameters:
      v1 - the first vertex to be compared.
      v2 - the second vertex to be compared.
      Returns:
      -1 if v1 comes before v2, +1 if v1 comes after v2, 0 if equal.