gov.sandia.cognition.graph.community

Interface NodePartitioning<NodeNameType>

Type Parameters:

NodeNameType - The type used to represent nodes

All Known Implementing Classes:

Louvain.LouvainHierarchy

public interface NodePartitioning<NodeNameType>

Interface for all graph partitioning classes

Author:

jdwendt

Method Summary

Modifier and Type	Method and Description
java.util.Set<NodeNameType>	getAllMembers() Returns all nodes stored within this partitioning
java.lang.Double	getModularity() Returns the modularity for this community specification.
int	getNumPartitions() Return the number of partitions in this partitioning
int	getPartition(NodeNameType node) Returns the partition id for the input node
int	getPartitionById(int nodeId) Returns the partition id for the input node
java.util.Set<NodeNameType>	getPartitionMembers(int i) Returns the members of the ith partition
static <NodeNameType> void	printPartitioning(NodePartitioning<NodeNameType> part) A helper pretty print method so that all partitionings can have the same look-and-feel.

Method Detail

getNumPartitions

int getNumPartitions()

Return the number of partitions in this partitioning

Returns:

the number of partitions in this partitioning

getPartitionMembers

java.util.Set<NodeNameType> getPartitionMembers(int i)

Returns the members of the ith partition

Parameters:

i - the 0-based index into the partitioning

Returns:

the members of the ith partition

getAllMembers

java.util.Set<NodeNameType> getAllMembers()

Returns all nodes stored within this partitioning

Returns:

all the nodes stored within this partitioning

getPartition

int getPartition(NodeNameType node)

Returns the partition id for the input node

Parameters:

node - The node whose partition is desired

Returns:

the partition id for the input node

getPartitionById

int getPartitionById(int nodeId)

Returns the partition id for the input node

Parameters:

nodeId - The node's ID (from the graph) whose partition is desired

Returns:

the partition id for the input node

getModularity

java.lang.Double getModularity()

Returns the modularity for this community specification. If not supported, return null

Returns:

the modularity for this community specification. If not supported, return null

printPartitioning

static <NodeNameType> void printPartitioning(NodePartitioning<NodeNameType> part)

A helper pretty print method so that all partitionings can have the same look-and-feel.

Type Parameters:

NodeNameType - The type for each node

Parameters:

part - The partition to print