edu.uci.ics.jung.algorithms.filters
Class KNeighborhoodFilter<V,E>

java.lang.Object
  extended by edu.uci.ics.jung.algorithms.filters.KNeighborhoodFilter<V,E>
All Implemented Interfaces:
Filter<V,E>, org.apache.commons.collections15.Transformer<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.

Author:
Danyel Fisher

Nested Class Summary
static class KNeighborhoodFilter.EdgeType
          The type of edge to follow for defining the neighborhood.
 
Constructor Summary
KNeighborhoodFilter(Set<V> rootNodes, int radiusK, KNeighborhoodFilter.EdgeType edgeType)
          Constructs a new instance of the filter.
KNeighborhoodFilter(V rootNode, int radiusK, KNeighborhoodFilter.EdgeType edgeType)
          Constructs a new instance of the filter.
 
Method Summary
 Graph<V,E> transform(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
 

Constructor Detail

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 Detail

transform

public Graph<V,E> transform(Graph<V,E> graph)
Constructs an unassembled graph containing the k-neighborhood around the root node(s).

Specified by:
transform in interface org.apache.commons.collections15.Transformer<Graph<V,E>,Graph<V,E>>


Copyright © 2011. All Rights Reserved.