Package elki.clustering.optics

Class OPTICSHeapEntry

  • All Implemented Interfaces:
    java.lang.Comparable<OPTICSHeapEntry>
    public class OPTICSHeapEntry
extends java.lang.Object
implements java.lang.Comparable<OPTICSHeapEntry>
    Entry in the priority heap.
    Since:
    0.1
    Author:
    Elke Achtert

    • Field Summary

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

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(OPTICSHeapEntry o)  
      boolean equals​(java.lang.Object o)
      Indicates whether some other object is "equal to" this one.
      int hashCode()
      Returns a hash code value for the object.
      java.lang.String toString()
      Returns a string representation of the object.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • objectID

        DBID objectID
        The id of the entry.

      • predecessorID

        DBID predecessorID
        The id of the entry's predecessor.

      • reachability

        double reachability
        The reachability of the entry.

    • Constructor Detail

      • OPTICSHeapEntry

        public OPTICSHeapEntry​(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​(java.lang.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 java.lang.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 java.lang.Object
        Returns:
        the object id if this entry

      • toString

        public java.lang.String toString()
        Returns a string representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the object.