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

Class ClusterOrderResult<E extends ClusterOrderEntry<?>>

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.ClusterOrderResult<E>

Type Parameters:

E - entry type.

All Implemented Interfaces:

DatabaseQuery, Relation<E>, HierarchicalResult, IterableResult<E>, Result, Iterable<E>

public class ClusterOrderResult<E extends ClusterOrderEntry<?>>
extends BasicResult
implements IterableResult<E>, Relation<E>

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

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ClusterOrderResult.ClusterOrderAdapter Ordering part of the result.

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayList<E>	clusterOrder Cluster order storage
(package private) Database	database The database.
(package private) DBIDs	ids The DBIDs we are defined for
private WritableDataStore<E>	map Map of object IDs to their cluster order entry

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Constructor Summary

Constructors

Constructor and Description
ClusterOrderResult(Database database, DBIDs ids, String name, String shortname) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(E ce) Add an object to the cluster order.
void	delete(DBIDRef id) Delete an objects values.
E	get(DBIDRef id) Get the representation of an object.
List<E>	getClusterOrder() Retrieve the complete cluster order.
Database	getDatabase() Get the associated database.
SimpleTypeInformation<E>	getDataTypeInformation() Get the data type of this representation
DBIDs	getDBIDs() Get the IDs the query is defined for.
Class<? super E>	getEntryType() Get the type of entries in this cluster order.
Iterator<E>	iterator() The cluster order is iterable
DBIDIter	iterDBIDs() Get an iterator access to the DBIDs.
void	set(DBIDRef id, E val) Set an object representation.
int	size() Get the number of DBIDs.

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 java.lang.Iterable

forEach, spliterator

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

getHierarchy, setHierarchy

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

getLongName, getShortName

Field Detail

clusterOrder

private ArrayList<E extends ClusterOrderEntry<?>> clusterOrder

Cluster order storage

map

private WritableDataStore<E extends ClusterOrderEntry<?>> map

Map of object IDs to their cluster order entry

ids

DBIDs ids

The DBIDs we are defined for

database

Database database

The database.

Constructor Detail

ClusterOrderResult

public ClusterOrderResult(Database database,
                          DBIDs ids,
                          String name,
                          String shortname)

Constructor

Parameters:

database - Database to attach the result to

ids - Object IDs included

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

Method Detail

getClusterOrder

public List<E> getClusterOrder()

Retrieve the complete cluster order.

Returns:

cluster order

getEntryType

public Class<? super E> getEntryType()

Get the type of entries in this cluster order.

Returns:

Cluster order

iterator

public Iterator<E> iterator()

The cluster order is iterable

Specified by:

iterator in interface IterableResult<E extends ClusterOrderEntry<?>>

Specified by:

iterator in interface Iterable<E extends ClusterOrderEntry<?>>

Returns:

iterator

add

public void add(E ce)

Add an object to the cluster order.

Parameters:

ce - Entry

getDatabase

public Database getDatabase()

Description copied from interface: Relation

Get the associated database. Note: in some situations, this might be null!

Specified by:

getDatabase in interface Relation<E extends ClusterOrderEntry<?>>

Returns:

Database

getDataTypeInformation

public SimpleTypeInformation<E> getDataTypeInformation()

Description copied from interface: Relation

Get the data type of this representation

Specified by:

getDataTypeInformation in interface Relation<E extends ClusterOrderEntry<?>>

Returns:

Data type

getDBIDs

public DBIDs getDBIDs()

Description copied from interface: Relation

Get the IDs the query is defined for.

Specified by:

getDBIDs in interface Relation<E extends ClusterOrderEntry<?>>

Returns:

IDs this is defined for

iterDBIDs

public DBIDIter iterDBIDs()

Description copied from interface: Relation

Get an iterator access to the DBIDs. To iterate over all IDs, use the following code fragment:

 
 for(DBIDIter iter = relation.iterDBIDs(); iter.valid(); iter.advance()) {
    relation.get(iter); // Get the current element
 }
 
 

Specified by:

iterDBIDs in interface Relation<E extends ClusterOrderEntry<?>>

Returns:

iterator for the DBIDs.

size

public int size()

Description copied from interface: Relation

Get the number of DBIDs.

Specified by:

size in interface Relation<E extends ClusterOrderEntry<?>>

Returns:

Size

get

public E get(DBIDRef id)

Description copied from interface: Relation

Get the representation of an object.

Specified by:

get in interface Relation<E extends ClusterOrderEntry<?>>

Parameters:

id - Object ID

Returns:

object instance

set

public void set(DBIDRef id,
                E val)

Description copied from interface: Relation

Set an object representation.

Specified by:

set in interface Relation<E extends ClusterOrderEntry<?>>

Parameters:

id - Object ID

val - Value

delete

public void delete(DBIDRef id)

Description copied from interface: Relation

Delete an objects values.

Specified by:

delete in interface Relation<E extends ClusterOrderEntry<?>>

Parameters:

id - ID to delete