blob: 360dda1238a36be99592d85d9891f05447798e06 (
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
package de.lmu.ifi.dbs.elki.database.ids.distance;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2013
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.database.ids.DBIDs;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
/**
* Collection of objects and their distances.
*
* To iterate over the results, use the following code:
*
* <pre>
* {@code
* for (DistanceDBIDResultIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
* // You can get the distance via: iter.getDistance();
* // Or use iter just like any other DBIDRef
* }
* }
* </pre>
*
* If you are only interested in the IDs of the objects, the following is also
* sufficient:
*
* <pre>
* {@code
* for (DBIDIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
* // Use iter just like any other DBIDRef
* }
* }
* </pre>
*
* @author Erich Schubert
*
* @apiviz.landmark
*
* @apiviz.composedOf DistanceDBIDPair
* @apiviz.has DistanceDBIDListIter
*
* @param <D> Distance type
*/
public interface DistanceDBIDList<D extends Distance<D>> extends DBIDs {
/**
* Size of list.
*
* @return Size
*/
@Override
int size();
/**
* Access a single pair.
*
* @param off Offset
* @return Pair
*/
DistanceDBIDPair<D> get(int off);
/**
* Get an iterator
*
* @return New iterator
*/
@Override
DistanceDBIDListIter<D> iter();
}
|
