de.lmu.ifi.dbs.elki.algorithm.clustering.optics

Class ClusterOrder

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.algorithm.clustering.optics.ClusterOrder

All Implemented Interfaces:

HierarchicalResult, OrderingResult, Result

Direct Known Subclasses:

CorrelationClusterOrder

public class ClusterOrder
extends BasicResult
implements OrderingResult

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

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ArrayModifiableDBIDs	ids Cluster order.
(package private) WritableDBIDDataStore	predecessor Predecessor storage.
(package private) WritableDoubleDataStore	reachability Reachability storage.

Constructor Summary

Constructors

Constructor and Description
ClusterOrder(DBIDs ids, String name, String shortname) Constructor
ClusterOrder(String name, String shortname, ArrayModifiableDBIDs ids, WritableDoubleDataStore reachability, WritableDBIDDataStore predecessor) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(DBIDRef id, double reach, DBIDRef pre) Add an object to the cluster order.
ArrayDBIDs	getDBIDs() Get the full set of DBIDs this ordering is defined for.
void	getPredecessor(DBIDRef id, DBIDVar out) Get the predecessor.
double	getReachability(DBIDRef id) Get the reachability of an object.
DBIDArrayIter	iter() Get an iterator.
ArrayModifiableDBIDs	order(DBIDs ids) Use the cluster order to sort the given collection ids.
int	size() Size.

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

getLongName, getShortName

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

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Field Detail

ids

ArrayModifiableDBIDs ids

Cluster order.

reachability

WritableDoubleDataStore reachability

Reachability storage.

predecessor

WritableDBIDDataStore predecessor

Predecessor storage. TODO: make optional.

Constructor Detail

ClusterOrder

public ClusterOrder(DBIDs ids,
            String name,
            String shortname)

Constructor

Parameters:

ids - Object IDs included

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

ClusterOrder

public ClusterOrder(String name,
            String shortname,
            ArrayModifiableDBIDs ids,
            WritableDoubleDataStore reachability,
            WritableDBIDDataStore predecessor)

Constructor

Parameters:

ids - Object IDs included

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

Method Detail

add

public void add(DBIDRef id,
       double reach,
       DBIDRef pre)

Add an object to the cluster order.

Parameters:

id - Object id

reach - Reachability

pre - Predecessor

getDBIDs

public ArrayDBIDs getDBIDs()

Description copied from interface: OrderingResult

Get the full set of DBIDs this ordering is defined for.

Specified by:

getDBIDs in interface OrderingResult

Returns:

DBIDs

iter

public DBIDArrayIter iter()

Get an iterator.

order

public ArrayModifiableDBIDs order(DBIDs ids)

Use the cluster order to sort the given collection ids. Implementation of the OrderingResult interface.

Specified by:

order in interface OrderingResult

Parameters:

ids - Collection of ids.

Returns:

iterator for sorted array of ids

size

public int size()

Size.

Returns:

Size

getReachability

public double getReachability(DBIDRef id)

Get the reachability of an object.

Parameters:

id - Object id

Returns:

Reachability

getPredecessor

public void getPredecessor(DBIDRef id,
                  DBIDVar out)

Get the predecessor.

Parameters:

id - Current id.

out - Output variable to store the predecessor.