Package elki.clustering.optics

Class ClusterOrder

  • All Implemented Interfaces:
    elki.result.OrderingResult
    Direct Known Subclasses:
    CorrelationClusterOrder
    public class ClusterOrder
extends java.lang.Object
implements elki.result.OrderingResult
    Class to store the result of an ordering clustering algorithm such as OPTICS.
    Since:
    0.7.0
    Author:
    Erich Schubert

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ClusterOrder​(elki.database.ids.ArrayModifiableDBIDs ids, elki.database.datastore.WritableDoubleDataStore reachability, elki.database.datastore.WritableDBIDDataStore predecessor)
      Constructor
      ClusterOrder​(elki.database.ids.DBIDs ids)
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(elki.database.ids.DBIDRef id, double reach, elki.database.ids.DBIDRef pre)
      Add an object to the cluster order.
      elki.database.ids.ArrayDBIDs getDBIDs()  
      void getPredecessor​(elki.database.ids.DBIDRef id, elki.database.ids.DBIDVar out)
      Get the predecessor.
      double getReachability​(elki.database.ids.DBIDRef id)
      Get the reachability of an object.
      elki.database.ids.DBIDArrayIter iter()
      Get an iterator.
      elki.database.ids.ArrayModifiableDBIDs order​(elki.database.ids.DBIDs ids)
      Use the cluster order to sort the given collection ids.
      int size()
      Size.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ids

        elki.database.ids.ArrayModifiableDBIDs ids
        Cluster order.

      • reachability

        elki.database.datastore.WritableDoubleDataStore reachability
        Reachability storage.

      • predecessor

        elki.database.datastore.WritableDBIDDataStore predecessor
        Predecessor storage.

    • Constructor Detail

      • ClusterOrder

        public ClusterOrder​(elki.database.ids.DBIDs ids)
        Constructor
        Parameters:
        ids - Object IDs included

      • ClusterOrder

        public ClusterOrder​(elki.database.ids.ArrayModifiableDBIDs ids,
                    elki.database.datastore.WritableDoubleDataStore reachability,
                    elki.database.datastore.WritableDBIDDataStore predecessor)
        Constructor
        Parameters:
        ids - Object IDs included

    • Method Detail

      • add

        public void add​(elki.database.ids.DBIDRef id,
                double reach,
                elki.database.ids.DBIDRef pre)
        Add an object to the cluster order.
        Parameters:
        id - Object id
        reach - Reachability
        pre - Predecessor

      • getDBIDs

        public elki.database.ids.ArrayDBIDs getDBIDs()
        Specified by:
        getDBIDs in interface elki.result.OrderingResult

      • iter

        public elki.database.ids.DBIDArrayIter iter()
        Get an iterator.

      • order

        public elki.database.ids.ArrayModifiableDBIDs order​(elki.database.ids.DBIDs ids)
        Use the cluster order to sort the given collection ids. Implementation of the OrderingResult interface.
        Specified by:
        order in interface elki.result.OrderingResult

      • size

        public int size()
        Size.
        Returns:
        Size

      • getReachability

        public double getReachability​(elki.database.ids.DBIDRef id)
        Get the reachability of an object.
        Parameters:
        id - Object id
        Returns:
        Reachability

      • getPredecessor

        public void getPredecessor​(elki.database.ids.DBIDRef id,
                           elki.database.ids.DBIDVar out)
        Get the predecessor.
        Parameters:
        id - Current id.
        out - Output variable to store the predecessor.