Package elki.index.preprocessed.knn

Class AbstractMaterializeKNNPreprocessor<O>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected elki.distance.Distance<? super O> distance
      The distance function to be used.
      protected elki.database.query.distance.DistanceQuery<O> distanceQuery
      The distance query we used.
      protected int k
      The query k value.
      protected elki.database.relation.Relation<O> relation
      The relation we are bound to.
      protected elki.database.datastore.WritableDataStore<elki.database.ids.KNNList> storage
      The data store.

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractMaterializeKNNPreprocessor​(elki.database.relation.Relation<O> relation, elki.database.query.distance.DistanceQuery<O> distanceQuery, int k)
      Constructor.
      AbstractMaterializeKNNPreprocessor​(elki.database.relation.Relation<O> relation, elki.distance.Distance<? super O> distance, int k)
      Constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      (package private) void createStorage()
      Create the default storage.
      elki.database.ids.KNNList get​(elki.database.ids.DBIDRef id)
      Get the k nearest neighbors.
      elki.database.query.distance.DistanceQuery<O> getDistanceQuery()
      The distance query we used.
      int getK()
      Get the value of 'k' supported by this preprocessor.
      protected abstract elki.logging.Logging getLogger()
      Get the classes static logger.
      void initialize()  
      PreprocessorKNNQuery kNNByDBID​(elki.database.query.distance.DistanceQuery<O> distQ, int maxk, int flags)  
      elki.database.query.knn.KNNSearcher<O> kNNByObject​(elki.database.query.distance.DistanceQuery<O> distanceQuery, int maxk, int flags)
      Deprecated.
      not possible
      protected abstract void preprocess()
      Perform the preprocessing step.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface elki.index.Index

        logStatistics

    • Field Detail

      • relation

        protected final elki.database.relation.Relation<O> relation
        The relation we are bound to.

      • k

        protected final int k
        The query k value.

      • distance

        protected final elki.distance.Distance<? super O> distance
        The distance function to be used.

      • distanceQuery

        protected final elki.database.query.distance.DistanceQuery<O> distanceQuery
        The distance query we used.

      • storage

        protected elki.database.datastore.WritableDataStore<elki.database.ids.KNNList> storage
        The data store.

    • Constructor Detail

      • AbstractMaterializeKNNPreprocessor

        public AbstractMaterializeKNNPreprocessor​(elki.database.relation.Relation<O> relation,
                                          elki.distance.Distance<? super O> distance,
                                          int k)
        Constructor.
        Parameters:
        relation - Relation
        distance - Distance function
        k - k

      • AbstractMaterializeKNNPreprocessor

        public AbstractMaterializeKNNPreprocessor​(elki.database.relation.Relation<O> relation,
                                          elki.database.query.distance.DistanceQuery<O> distanceQuery,
                                          int k)
        Constructor.
        Parameters:
        relation - Relation
        distanceQuery - Distance query
        k - k

    • Method Detail

      • getDistanceQuery

        public elki.database.query.distance.DistanceQuery<O> getDistanceQuery()
        The distance query we used.
        Returns:
        Distance query

      • getK

        public int getK()
        Get the value of 'k' supported by this preprocessor.
        Returns:
        k

      • preprocess

        protected abstract void preprocess()
        Perform the preprocessing step.

      • get

        public elki.database.ids.KNNList get​(elki.database.ids.DBIDRef id)
        Get the k nearest neighbors.
        Parameters:
        id - Object ID
        Returns:
        Neighbors

      • createStorage

        void createStorage()
        Create the default storage.

      • initialize

        public void initialize()
        Specified by:
        initialize in interface elki.index.Index

      • kNNByObject

        @Deprecated
public elki.database.query.knn.KNNSearcher<O> kNNByObject​(elki.database.query.distance.DistanceQuery<O> distanceQuery,
                                                          int maxk,
                                                          int flags)
        Deprecated.
        not possible
        Specified by:
        kNNByObject in interface elki.index.KNNIndex<O>

      • kNNByDBID

        public PreprocessorKNNQuery kNNByDBID​(elki.database.query.distance.DistanceQuery<O> distQ,
                                      int maxk,
                                      int flags)
        Specified by:
        kNNByDBID in interface elki.index.KNNIndex<O>

      • getLogger

        protected abstract elki.logging.Logging getLogger()
        Get the classes static logger.
        Returns:
        Logger