Class KNeighborhoodFilter<V,​E>

  • All Implemented Interfaces:
    com.google.common.base.Function<Graph<V,​E>,​Graph<V,​E>>, Filter<V,​E>, java.util.function.Function<Graph<V,​E>,​Graph<V,​E>>

    public class KNeighborhoodFilter<V,​E>
    extends java.lang.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.
    Author:
    Danyel Fisher
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KNeighborhoodFilter.EdgeType
      The type of edge to follow for defining the neighborhood.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Graph<V,​E> apply​(Graph<V,​E> graph)
      Constructs an unassembled graph containing the k-neighborhood around the root node(s).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.google.common.base.Function

        equals
      • Methods inherited from interface java.util.function.Function

        andThen, compose
    • Constructor Detail

      • KNeighborhoodFilter

        public KNeighborhoodFilter​(java.util.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 Detail

      • 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 java.util.function.Function<V,​E>