blob: 547f3297c1b891795b63fa3cb1eeced05347ee3a (
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
88
89
90
91
|
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) 2012
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/>.
*/
/**
* Interface for a generic modifiable DBID collection.
*
* Note: we had this use the Java Collections API for a long time, however this
* prevented certain optimizations. So it now only mimics the Collections API
* <em>deliberately</em>.
*
* @author Erich Schubert
*
* @apiviz.has DBIDMIter
*/
public interface ModifiableDBIDs extends DBIDs {
/**
* Add DBIDs to collection.
*
* @param ids IDs to add.
* @return {@code true} when modified
*/
boolean addDBIDs(DBIDs ids);
/**
* Remove DBIDs from collection.
*
* @param ids IDs to remove.
* @return {@code true} when modified
*/
boolean removeDBIDs(DBIDs ids);
/**
* Add a single DBID to the collection.
*
* @param id ID to add
*/
boolean add(DBIDRef id);
/**
* Remove a single DBID from the collection.
*
* @param id ID to remove
*/
boolean remove(DBIDRef id);
/**
* Clear this collection.
*/
void clear();
/**
* Get a <em>modifiable</em> DBID iterator (a more efficient API).
*
* usage example:
*
* <pre>
* {@code
* for(DBIDMIter iter = ids.iter(); iter.valid(); iter.advance()) {
* DBID id = iter.getDBID();
* iter.remove();
* }
* }
* </pre>
*
* @return modifiable iterator
*/
@Override
DBIDMIter iter();
}
|
