GvmKeyer (HM Gears 0.10.7 API)

Type Parameters:

K -

All Known Implementing Classes:

GvmDefaultKeyer, GvmListKeyer, GvmNullKeyer, GvmSimpleKeyer
```
public interface GvmKeyer<K>
```
Controls how new keys are added to clusters and how keys are combined when clusters merge. Any number of strategies are possible including: some applications may simply discard all keys (if the salient information is simply the cluster sizes), some applications may choose the key of the largest cluster (if the salient information is an exemplar for each cluster), and some applications may choose to maintain a list of keys (if every key needs to be mapped back to a cluster).

Author:

Tom Gibara

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`K`	`addKey(GvmCluster<?,K> cluster, K key)`	Called when a key is being added to a cluster.
`K`	`mergeKeys(GvmCluster<?,K> c1, GvmCluster<?,K> c2)`	Called when two clusters are being merged.

- Method Detail
  - mergeKeys
```
K mergeKeys(GvmCluster<?,K> c1,
            GvmCluster<?,K> c2)
```
    Called when two clusters are being merged. One key needs to be chosen/synthesized from those of the clusters being merged.
    
    Parameters:
    
    c1 - the cluster with the greater mass
    
    c2 - the cluster with the lesser mass
    
    Returns:
    
    a key for the cluster that combines those of c1 and c2, may be null
  - addKey
```
K addKey(GvmCluster<?,K> cluster,
         K key)
```
    Called when a key is being added to a cluster.
    
    Parameters:
    
    cluster - a cluster
    
    key - the key for a newly clustered coordinate
    
    Returns:
    
    the key to be assigned to the new cluster, may be null