summaryrefslogtreecommitdiff
path: root/elki/src/main/java/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mktab/MkTabEntry.java
blob: 2b2a247d96f9861a894d7136e47c651f8cb67218 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mktab;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2015
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.MTreeEntry;

/**
 * Defines the requirements for an entry in an MkCop-Tree node. Additionally to
 * an entry in an M-Tree an MkTabEntry holds a list of knn distances for for
 * parameters k <= k_max of the underlying data object or MkTab-Tree node.
 * 
 * @author Elke Achtert
 * @since 0.2
 */
interface MkTabEntry extends MTreeEntry {
  /**
   * Returns the list of knn distances of the entry.
   * 
   * @return the list of knn distances of the entry
   */
  public double[] getKnnDistances();

  /**
   * Sets the knn distances of the entry.
   * 
   * @param knnDistances the knn distances to be set
   */
  public void setKnnDistances(double[] knnDistances);

  /**
   * Returns the knn distance of the entry for the specified parameter k.
   * 
   * @param k the parameter k of the knn distance
   * @return the knn distance of the entry
   */
  public double getKnnDistance(int k);
}