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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
package de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.deliclu;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2011
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 java.util.ArrayList;
import java.util.List;
import de.lmu.ifi.dbs.elki.data.NumberVector;
import de.lmu.ifi.dbs.elki.database.ids.DBID;
import de.lmu.ifi.dbs.elki.database.ids.DBIDs;
import de.lmu.ifi.dbs.elki.database.query.distance.DistanceQuery;
import de.lmu.ifi.dbs.elki.database.query.distance.SpatialDistanceQuery;
import de.lmu.ifi.dbs.elki.database.query.knn.KNNQuery;
import de.lmu.ifi.dbs.elki.database.query.range.RangeQuery;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
import de.lmu.ifi.dbs.elki.index.KNNIndex;
import de.lmu.ifi.dbs.elki.index.RangeIndex;
import de.lmu.ifi.dbs.elki.index.tree.IndexTreePath;
import de.lmu.ifi.dbs.elki.index.tree.TreeIndexPathComponent;
import de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.bulk.BulkSplit;
import de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.query.RStarTreeUtil;
import de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.util.InsertionStrategy;
import de.lmu.ifi.dbs.elki.logging.Logging;
import de.lmu.ifi.dbs.elki.persistent.PageFile;
/**
* The common use of the DeLiClu tree: indexing number vectors.
*
* @author Erich Schubert
*
* @param <O> Object type
*/
public class DeLiCluTreeIndex<O extends NumberVector<?, ?>> extends DeLiCluTree implements KNNIndex<O>, RangeIndex<O> {
/**
* The relation we index
*/
private Relation<O> relation;
/**
* Constructor.
*
* @param relation Relation to index
* @param pagefile Page file
* @param bulkSplitter bulk load strategy
* @param insertionStrategy the strategy to find the insertion child
*/
public DeLiCluTreeIndex(Relation<O> relation, PageFile<DeLiCluNode> pagefile, BulkSplit bulkSplitter, InsertionStrategy insertionStrategy) {
super(pagefile, bulkSplitter, insertionStrategy);
this.relation = relation;
this.initialize();
}
/**
* The appropriate logger for this index.
*/
private static final Logging logger = Logging.getLogger(DeLiCluTreeIndex.class);
/**
* Creates a new leaf entry representing the specified data object.
*
* @param id Object id
*/
protected DeLiCluLeafEntry createNewLeafEntry(DBID id) {
return new DeLiCluLeafEntry(id, relation.get(id));
}
/**
* Marks the specified object as handled and returns the path of node ids from
* the root to the objects's parent.
*
* @param id the objects id to be marked as handled
* @param obj the object to be marked as handled
* @return the path of node ids from the root to the objects's parent
*/
public synchronized List<TreeIndexPathComponent<DeLiCluEntry>> setHandled(DBID id, O obj) {
if(logger.isDebugging()) {
logger.debugFine("setHandled " + id + ", " + obj + "\n");
}
// find the leaf node containing o
IndexTreePath<DeLiCluEntry> pathToObject = findPathToObject(getRootPath(), obj, id);
if(pathToObject == null) {
return null;
}
// set o handled
DeLiCluEntry entry = pathToObject.getLastPathComponent().getEntry();
entry.setHasHandled(true);
entry.setHasUnhandled(false);
for(IndexTreePath<DeLiCluEntry> path = pathToObject; path.getParentPath() != null; path = path.getParentPath()) {
DeLiCluEntry parentEntry = path.getParentPath().getLastPathComponent().getEntry();
DeLiCluNode node = getNode(parentEntry);
boolean hasHandled = false;
boolean hasUnhandled = false;
for(int i = 0; i < node.getNumEntries(); i++) {
final DeLiCluEntry nodeEntry = node.getEntry(i);
hasHandled = hasHandled || nodeEntry.hasHandled();
hasUnhandled = hasUnhandled || nodeEntry.hasUnhandled();
}
parentEntry.setHasUnhandled(hasUnhandled);
parentEntry.setHasHandled(hasHandled);
}
return pathToObject.getPath();
}
/**
* Inserts the specified real vector object into this index.
*
* @param id the object id that was inserted
*/
@Override
public final void insert(DBID id) {
insertLeaf(createNewLeafEntry(id));
}
/**
* Inserts the specified objects into this index. If a bulk load mode is
* implemented, the objects are inserted in one bulk.
*
* @param ids the objects to be inserted
*/
@Override
public final void insertAll(DBIDs ids) {
if(ids.isEmpty() || (ids.size() == 1)) {
return;
}
// Make an example leaf
if(canBulkLoad()) {
List<DeLiCluEntry> leafs = new ArrayList<DeLiCluEntry>(ids.size());
for(DBID id : ids) {
leafs.add(createNewLeafEntry(id));
}
bulkLoad(leafs);
}
else {
for(DBID id : ids) {
insert(id);
}
}
doExtraIntegrityChecks();
}
/**
* Deletes the specified object from this index.
*
* @return true if this index did contain the object with the specified id,
* false otherwise
*/
@Override
public final boolean delete(DBID id) {
// find the leaf node containing o
O obj = relation.get(id);
IndexTreePath<DeLiCluEntry> deletionPath = findPathToObject(getRootPath(), obj, id);
if(deletionPath == null) {
return false;
}
deletePath(deletionPath);
return true;
}
@Override
public void deleteAll(DBIDs ids) {
for(DBID id : ids) {
delete(id);
}
}
@Override
public <D extends Distance<D>> RangeQuery<O, D> getRangeQuery(DistanceQuery<O, D> distanceQuery, Object... hints) {
// Query on the relation we index
if(distanceQuery.getRelation() != relation) {
return null;
}
// Can we support this distance function - spatial distances only!
if(!(distanceQuery instanceof SpatialDistanceQuery)) {
return null;
}
SpatialDistanceQuery<O, D> dq = (SpatialDistanceQuery<O, D>) distanceQuery;
return RStarTreeUtil.getRangeQuery(this, dq, hints);
}
@Override
public <D extends Distance<D>> KNNQuery<O, D> getKNNQuery(DistanceQuery<O, D> distanceQuery, Object... hints) {
// Query on the relation we index
if(distanceQuery.getRelation() != relation) {
return null;
}
// Can we support this distance function - spatial distances only!
if(!(distanceQuery instanceof SpatialDistanceQuery)) {
return null;
}
SpatialDistanceQuery<O, D> dq = (SpatialDistanceQuery<O, D>) distanceQuery;
return RStarTreeUtil.getKNNQuery(this, dq, hints);
}
@Override
public String getLongName() {
return "DeLiClu-Tree";
}
@Override
public String getShortName() {
return "deliclutree";
}
@Override
protected Logging getLogger() {
return logger;
}
}
|
