gov.sandia.cognition.graph.community

Class Louvain.LouvainHierarchy<NodeNameType>

java.lang.Object

gov.sandia.cognition.graph.community.Louvain.LouvainHierarchy<NodeNameType>

Type Parameters:

NodeNameType - The class-type of the nodes in the graph this references.

All Implemented Interfaces:

NodePartitioning<NodeNameType>

Enclosing class:

Louvain<NodeNameType>

public static class Louvain.LouvainHierarchy<NodeNameType>
extends java.lang.Object
implements NodePartitioning<NodeNameType>

The return type from running Louvain. Can be queried for the community ID for a node either for the top-level or for any level in the hierarchy.

Method Summary

Modifier and Type	Method and Description
java.util.Set<NodeNameType>	getAllMembers() Returns all nodes stored within this partitioning
int	getCommunityForNodeAtLevel(NodeNameType n, int level) Returns the community ID for the input node at the input level
int	getCommunityForNodeAtLevelById(int nodeId, int level)
java.lang.Double	getModularity() Returns the modularity for this community specification.
double	getModularity(int level) Returns the modularity at the input level of the hierarchy.
int	getNumCommunitiesAtLevel(int level) Returns the number of communities at the input level of the hierarchy.
int	getNumPartitions() Return the number of partitions in this partitioning
int	getPartition(NodeNameType n) 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
int	numLevels() The number of levels in the hierarchy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.sandia.cognition.graph.community.NodePartitioning

printPartitioning

Method Detail

numLevels

public int numLevels()

The number of levels in the hierarchy.

Returns:

the number of levels in the hierarchy

getModularity

public double getModularity(int level)

Returns the modularity at the input level of the hierarchy.

Parameters:

level - The level to check on

Returns:

the modularity at the input level of the hierarchy.

Throws:

java.lang.IllegalArgumentException - if the input level isn't in this datastructure.

getNumCommunitiesAtLevel

public int getNumCommunitiesAtLevel(int level)

Returns the number of communities at the input level of the hierarchy.

Parameters:

level - The level to check on

Returns:

the number of communities at the input level of the hierarchy.

Throws:

java.lang.IllegalArgumentException - if the input level isn't in this datastructure.

getCommunityForNodeAtLevel

public int getCommunityForNodeAtLevel(NodeNameType n,
                                      int level)

Returns the community ID for the input node at the input level

Parameters:

n - The node to search for

level - The level to search on

Returns:

The community ID at that level

Throws:

java.lang.IllegalArgumentException - if the input node isn't in the graph, or if the level isn't valid

getCommunityForNodeAtLevelById

public int getCommunityForNodeAtLevelById(int nodeId,
                                          int level)

getPartition

public int getPartition(NodeNameType n)

Description copied from interface: NodePartitioning

Returns the partition id for the input node

Specified by:

getPartition in interface NodePartitioning<NodeNameType>

Parameters:

n - The node whose partition is desired

Returns:

the partition id for the input node

getPartitionById

public int getPartitionById(int nodeId)

Description copied from interface: NodePartitioning

Returns the partition id for the input node

Specified by:

getPartitionById in interface NodePartitioning<NodeNameType>

Parameters:

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

Returns:

the partition id for the input node

getNumPartitions

public int getNumPartitions()

Description copied from interface: NodePartitioning

Return the number of partitions in this partitioning

Specified by:

getNumPartitions in interface NodePartitioning<NodeNameType>

Returns:

the number of partitions in this partitioning

getPartitionMembers

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

Description copied from interface: NodePartitioning

Returns the members of the ith partition

Specified by:

getPartitionMembers in interface NodePartitioning<NodeNameType>

Parameters:

i - the 0-based index into the partitioning

Returns:

the members of the ith partition

getAllMembers

public java.util.Set<NodeNameType> getAllMembers()

Description copied from interface: NodePartitioning

Returns all nodes stored within this partitioning

Specified by:

getAllMembers in interface NodePartitioning<NodeNameType>

Returns:

all the nodes stored within this partitioning

getModularity

public java.lang.Double getModularity()

Description copied from interface: NodePartitioning

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

Specified by:

getModularity in interface NodePartitioning<NodeNameType>

Returns:

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