de.lmu.ifi.dbs.elki.result
Class ClusterOrderResult<D extends Distance<?>>

java.lang.Object
  de.lmu.ifi.dbs.elki.result.MultiResult
      de.lmu.ifi.dbs.elki.result.ClusterOrderResult<D>

Type Parameters:

D - distance type.

All Implemented Interfaces:

Result, Iterable<ClusterOrderEntry<D>>

public class ClusterOrderResult<D extends Distance<?>>
extends MultiResult
implements Iterable<ClusterOrderEntry<D>>

Class to store the result of an ordering clustering algorithm such as OPTICS.

Author:

Erich Schubert

Nested Class Summary

(package private) class	ClusterOrderResult.ClusterOrderAdapter Ordering part of the result.
(package private) class	ClusterOrderResult.PredecessorAdapter Result containing the predecessor ID.
(package private) class	ClusterOrderResult.ReachabilityDistanceAdapter Result containing the reachability distances.

Field Summary

private ArrayList<ClusterOrderEntry<D>>	clusterOrder Cluster order storage
private HashMap<Integer,ClusterOrderEntry<D>>	map Map of object IDs to their cluster order entry
static AssociationID<Integer>	PREDECESSOR_ID Predecessor ID for reachability distance.
static AssociationID<? extends Distance<?>>	REACHABILITY_ID Association ID for reachability distance.

Constructor Summary

ClusterOrderResult()
Constructor

Method Summary

void	add(ClusterOrderEntry<D> ce) Add an object to the cluster order.
void	add(Integer id, Integer predecessor, D reachability) Add an object to the cluster order.
List<ClusterOrderEntry<D>>	getClusterOrder() Retrieve the complete cluster order.
String	getName() Get a user-understandable name for this result.
Iterator<ClusterOrderEntry<D>>	iterator() The cluster order is iterable

Methods inherited from class de.lmu.ifi.dbs.elki.result.MultiResult

addResult, filterResults, getAssociation, getAssociationGenerics, getAssociations, getFirstFilteredResult, getResults, prependResult, setAssociation

Methods inherited from class java.lang.Object

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

Field Detail

REACHABILITY_ID

public static final AssociationID<? extends Distance<?>> REACHABILITY_ID

Association ID for reachability distance.

PREDECESSOR_ID

public static final AssociationID<Integer> PREDECESSOR_ID

Predecessor ID for reachability distance.

clusterOrder

private ArrayList<ClusterOrderEntry<D extends Distance<?>>> clusterOrder

Cluster order storage

map

private HashMap<Integer,ClusterOrderEntry<D extends Distance<?>>> map

Map of object IDs to their cluster order entry

Constructor Detail

ClusterOrderResult

public ClusterOrderResult()

Constructor

Method Detail

getClusterOrder

public List<ClusterOrderEntry<D>> getClusterOrder()

Retrieve the complete cluster order.

Returns:

cluster order

iterator

public Iterator<ClusterOrderEntry<D>> iterator()

The cluster order is iterable

Specified by:

iterator in interface Iterable<ClusterOrderEntry<D extends Distance<?>>>

add

public void add(Integer id,
                Integer predecessor,
                D reachability)

Add an object to the cluster order.

Parameters:

id - Object ID

predecessor - Predecessor ID

reachability - Reachability distance

add

public void add(ClusterOrderEntry<D> ce)

Add an object to the cluster order.

Parameters:

ce - Entry

getName

public String getName()

Description copied from interface: Result

Get a user-understandable name for this result. Defaults may be returned such as "list" for a list result.

Specified by:

getName in interface Result

Overrides:

getName in class MultiResult

Returns:

result name