Class KNeighborhoodFilter<V,E>

java.lang.Object
edu.uci.ics.jung.algorithms.filters.KNeighborhoodFilter<V,E>
All Implemented Interfaces:
com.google.common.base.Function<Graph<V,E>,Graph<V,E>>, Filter<V,E>, Function<Graph<V,E>,Graph<V,E>>

public class KNeighborhoodFilter<V,E> extends Object implements Filter<V,E>
A filter used to extract the k-neighborhood around one or more root node(s). The k-neighborhood is defined as the subgraph induced by the set of vertices that are k or fewer hops (unweighted shortest-path distance) away from the root node.
  • Field Details

  • Constructor Details

    • KNeighborhoodFilter

      public KNeighborhoodFilter(Set<V> rootNodes, int radiusK, KNeighborhoodFilter.EdgeType edgeType)
      Constructs a new instance of the filter.
      Parameters:
      rootNodes - the set of root nodes
      radiusK - the neighborhood radius around the root set
      edgeType - 0 for in/out edges, 1 for in-edges, 2 for out-edges
    • KNeighborhoodFilter

      public KNeighborhoodFilter(V rootNode, int radiusK, KNeighborhoodFilter.EdgeType edgeType)
      Constructs a new instance of the filter.
      Parameters:
      rootNode - the root node
      radiusK - the neighborhood radius around the root set
      edgeType - 0 for in/out edges, 1 for in-edges, 2 for out-edges
  • Method Details

    • apply

      public Graph<V,E> apply(Graph<V,E> graph)
      Constructs an unassembled graph containing the k-neighborhood around the root node(s).
      Specified by:
      apply in interface com.google.common.base.Function<V,E>
      Specified by:
      apply in interface Function<V,E>