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

Class DoubleDistanceClusterOrderEntry

java.lang.Object

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

All Implemented Interfaces:

ClusterOrderEntry<DoubleDistanceClusterOrderEntry>, TextWriteable, Comparable<DoubleDistanceClusterOrderEntry>

public class DoubleDistanceClusterOrderEntry
extends Object
implements ClusterOrderEntry<DoubleDistanceClusterOrderEntry>, TextWriteable

Entry in a ClusterOrderResult.

Author:

Elke Achtert

Field Summary

Fields

Modifier and Type	Field and Description
private DBID	objectID The id of the entry.
private DBID	predecessorID The id of the entry's predecessor.
private double	reachability The reachability of the entry.

Constructor Summary

Constructors

Constructor and Description
DoubleDistanceClusterOrderEntry(DBID objectID, DBID predecessorID, double reachability) Creates a new entry in a cluster order with the specified parameters.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DoubleDistanceClusterOrderEntry o)
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
DBID	getID() Returns the object id of this entry.
DBID	getPredecessorID() Returns the id of the predecessor of this entry if this entry has a predecessor, null otherwise.
double	getReachability() Returns the reachability distance of this entry
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToText(TextWriterStream out, String label) Write self to the given TextWriterStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

objectID

private DBID objectID

The id of the entry.

predecessorID

private DBID predecessorID

The id of the entry's predecessor.

reachability

private double reachability

The reachability of the entry.

Constructor Detail

DoubleDistanceClusterOrderEntry

public DoubleDistanceClusterOrderEntry(DBID objectID,
                                       DBID predecessorID,
                                       double reachability)

Creates a new entry in a cluster order with the specified parameters.

Parameters:

objectID - the id of the entry

predecessorID - the id of the entry's predecessor

reachability - the reachability of the entry

Method Detail

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one. NOTE: for the use in an UpdatableHeap, only the ID is compared!

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object has the same attribute values as the o argument; false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

Returns:

the object id if this entry

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.

getID

public DBID getID()

Returns the object id of this entry.

Specified by:

getID in interface ClusterOrderEntry<DoubleDistanceClusterOrderEntry>

Returns:

the object id of this entry

getPredecessorID

public DBID getPredecessorID()

Returns the id of the predecessor of this entry if this entry has a predecessor, null otherwise.

Specified by:

getPredecessorID in interface ClusterOrderEntry<DoubleDistanceClusterOrderEntry>

Returns:

the id of the predecessor of this entry

getReachability

public double getReachability()

Returns the reachability distance of this entry

Returns:

the reachability distance of this entry

compareTo

public int compareTo(DoubleDistanceClusterOrderEntry o)

Specified by:

compareTo in interface Comparable<DoubleDistanceClusterOrderEntry>

writeToText

public void writeToText(TextWriterStream out,
                        String label)

Description copied from interface: TextWriteable

Write self to the given TextWriterStream

Specified by:

writeToText in interface TextWriteable

Parameters:

out - Output writer

label - Label