y.layout
Class PartitionLayouter.EdgeBetweennessPartitionFinder

java.lang.Object
  y.layout.PartitionLayouter.EdgeBetweennessPartitionFinder

All Implemented Interfaces:

PartitionLayouter.PartitionFinder

Enclosing class:

PartitionLayouter

public static class PartitionLayouter.EdgeBetweennessPartitionFinder
extends java.lang.Object
implements PartitionLayouter.PartitionFinder

PartitionLayouter.EdgeBetweennessPartitionFinder uses Groups.edgeBetweennessClustering(y.base.Graph, NodeMap, boolean, int, int, DataProvider) as strategy for finding graph partitions.

Constructor Summary

PartitionLayouter.EdgeBetweennessPartitionFinder()
Creates a new instance of PartitionLayouter.EdgeBetweennessPartitionFinder.

Method Summary

void	findPartitions(LayoutGraph graph, NodeMap clusterIDMap) Returns a partition ID for each node of an input graph.
int	getMaximumPartitionCount() Returns the maximum number of partitions the result should have.
int	getMinimumPartitionCount() Returns the minimum number of partitions the result should have.
void	setMaximumPartitionCount(int maximumPartitionCount) Specifies the maximum number of partitions the result should have.
void	setMinimumPartitionCount(int minimumPartitionCount) Specifies the minimum number of partitions the result should have.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartitionLayouter.EdgeBetweennessPartitionFinder

public PartitionLayouter.EdgeBetweennessPartitionFinder()

Creates a new instance of PartitionLayouter.EdgeBetweennessPartitionFinder.

Method Detail

findPartitions

public void findPartitions(LayoutGraph graph,
                           NodeMap clusterIDMap)

Description copied from interface: PartitionLayouter.PartitionFinder

Returns a partition ID for each node of an input graph. Nodes that share a common partition ID are considered to belong to the same partition.

Specified by:

findPartitions in interface PartitionLayouter.PartitionFinder

Parameters:

graph - the input graph

clusterIDMap - the map that is filled with the resulting partition IDs

getMaximumPartitionCount

public int getMaximumPartitionCount()

Returns the maximum number of partitions the result should have.

The number of partitions must be non-negative.

Returns:

the maximum number of partitions

See Also:

setMaximumPartitionCount(int)

setMaximumPartitionCount

public void setMaximumPartitionCount(int maximumPartitionCount)

Specifies the maximum number of partitions the result should have.

The number of partitions must be non-negative.

Default Value:

The default value is Integer.MAX_VALUE. There is no limit to the number of returned partitions.

Parameters:

maximumPartitionCount - the maximum number of partitions

Throws:

java.lang.IllegalArgumentException - if the specified count is negative

getMinimumPartitionCount

public int getMinimumPartitionCount()

Returns the minimum number of partitions the result should have.

The number of partitions must be non-negative.

Returns:

the minimum number of partitions

See Also:

setMinimumPartitionCount(int)

setMinimumPartitionCount

public void setMinimumPartitionCount(int minimumPartitionCount)

Specifies the minimum number of partitions the result should have.

The number of partitions must be non-negative.

Default Value:

The default value is 0.

Parameters:

minimumPartitionCount - the minimum number of partitions

Throws:

java.lang.IllegalArgumentException - if the specified count is negative