blob: f051d51c94766fae21e38572f8ecd3f55babb9ed (
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
|
package de.lmu.ifi.dbs.elki.database.ids;
/*
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.utilities.datastructures.iterator.Iter;
/**
* Iterator for DBIDs.
*
* Important note: this iterator has a <em>significantly</em> different syntax
* and semantics than the Java iterators. It is much more aligned with C than
* with Java, but at the same time, the syntax is much more compatible with for
* loops.
*
* Usage example:
*
* <pre>
* {@code
* for (DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
* Object o = relation.get(iter); // Many interfaces allow direct use
* DBID id = DBIDUtil.deref(iter); // Materialize only if you need to!
* }
* }
* </pre>
*
* We list some fundamental differences.
* <ul>
* <li>{@link DBIDIter#valid() iter.valid()} refers to the current element,
* {@code Iterator.next()} to the next.</li>
* <li>{@link DBIDIter#advance() iter.advance()} does not return an element. Use
* {@code get...} to access it.</li>
* <li>{@code DBIDIter.get...} do not advance the iterator.</li>
* </ul>
*
* @author Erich Schubert
*
* @apiviz.landmark
*/
public interface DBIDIter extends DBIDRef, Iter {
// Empty - use as DBIDRef or Iter
}
|
