gov.sandia.cognition.learning.algorithm.clustering
Class AgglomerativeClusterer.HierarchyNode<DataType,ClusterType extends Cluster<DataType>>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.algorithm.clustering.hierarchy.AbstractClusterHierarchyNode<DataType,ClusterType>
          extended by gov.sandia.cognition.learning.algorithm.clustering.hierarchy.BinaryClusterHierarchyNode<DataType,ClusterType>
              extended by gov.sandia.cognition.learning.algorithm.clustering.AgglomerativeClusterer.HierarchyNode<DataType,ClusterType>
Type Parameters:
DataType - The type of the data being clustered.
ClusterType - The type of the clusters being created.
All Implemented Interfaces:
Cluster<DataType>, ClusterHierarchyNode<DataType,ClusterType>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
AgglomerativeClusterer<DataType,ClusterType extends Cluster<DataType>>

public static class AgglomerativeClusterer.HierarchyNode<DataType,ClusterType extends Cluster<DataType>>
extends BinaryClusterHierarchyNode<DataType,ClusterType>

Holds the hierarchy information for the agglomerative clusterer. It is a binary node that also keeps track of the divergence between children.

See Also:
Serialized Form

Field Summary
protected  double childrenDivergence
          The divergence between the two children, if they exist.
 
Fields inherited from class gov.sandia.cognition.learning.algorithm.clustering.hierarchy.BinaryClusterHierarchyNode
firstChild, secondChild
 
Fields inherited from class gov.sandia.cognition.learning.algorithm.clustering.hierarchy.AbstractClusterHierarchyNode
cluster
 
Constructor Summary
AgglomerativeClusterer.HierarchyNode()
          Creates a new HierarchyNode.
AgglomerativeClusterer.HierarchyNode(ClusterType cluster)
          Creates a new HierarchyNode.
AgglomerativeClusterer.HierarchyNode(ClusterType cluster, AgglomerativeClusterer.HierarchyNode<DataType,ClusterType> firstChild, AgglomerativeClusterer.HierarchyNode<DataType,ClusterType> secondChild, double childrenDivergence)
          Creates a new HierarchyNode.
 
Method Summary
 double getChildrenDivergence()
          Gets the divergence between the two children, if they exist; otherwise, 0.0.
 void setChildrenDivergence(double childrenDivergence)
          Sets the divergence between the two children.
 
Methods inherited from class gov.sandia.cognition.learning.algorithm.clustering.hierarchy.BinaryClusterHierarchyNode
getChildren, getFirstChild, getSecondChild, hasChildren, setFirstChild, setSecondChild
 
Methods inherited from class gov.sandia.cognition.learning.algorithm.clustering.hierarchy.AbstractClusterHierarchyNode
getCluster, getMembers, setCluster
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 

Field Detail

childrenDivergence

protected double childrenDivergence
The divergence between the two children, if they exist.

Constructor Detail

AgglomerativeClusterer.HierarchyNode

public AgglomerativeClusterer.HierarchyNode()
Creates a new HierarchyNode.


AgglomerativeClusterer.HierarchyNode

public AgglomerativeClusterer.HierarchyNode(ClusterType cluster)
Creates a new HierarchyNode.

Parameters:
cluster - The cluster associated with the node.

AgglomerativeClusterer.HierarchyNode

public AgglomerativeClusterer.HierarchyNode(ClusterType cluster,
                                            AgglomerativeClusterer.HierarchyNode<DataType,ClusterType> firstChild,
                                            AgglomerativeClusterer.HierarchyNode<DataType,ClusterType> secondChild,
                                            double childrenDivergence)
Creates a new HierarchyNode.

Parameters:
cluster - The cluster associated with the node.
firstChild - The first child.
secondChild - The second child.
childrenDivergence - The divergence between the children.
Method Detail

getChildrenDivergence

public double getChildrenDivergence()
Gets the divergence between the two children, if they exist; otherwise, 0.0.

Returns:
The divergence between the two children, if they exist.

setChildrenDivergence

public void setChildrenDivergence(double childrenDivergence)
Sets the divergence between the two children.

Parameters:
childrenDivergence - The divergence between the two children.