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
|
package de.lmu.ifi.dbs.elki.index.tree;
/*
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 de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.index.Index;
import de.lmu.ifi.dbs.elki.index.IndexFactory;
import de.lmu.ifi.dbs.elki.persistent.LRUCache;
import de.lmu.ifi.dbs.elki.persistent.MemoryPageFile;
import de.lmu.ifi.dbs.elki.persistent.Page;
import de.lmu.ifi.dbs.elki.persistent.PageFile;
import de.lmu.ifi.dbs.elki.persistent.PersistentPageFile;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.GreaterConstraint;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.GreaterEqualConstraint;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.FileParameter;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.LongParameter;
/**
* Abstract base class for tree-based indexes.
*
* @author Erich Schubert
*
* @apiviz.stereotype factory,interface
* @apiviz.uses Index oneway - - «create»
*
* @param <O> Object type
* @param <I> Index type
*/
public abstract class TreeIndexFactory<O, I extends Index> implements IndexFactory<O, I> {
/**
* Optional parameter that specifies the name of the file storing the index.
* If this parameter is not set the index is hold in the main memory.
* <p>
* Key: {@code -treeindex.file}
* </p>
*/
public static final OptionID FILE_ID = OptionID.getOrCreateOptionID("treeindex.file", "The name of the file storing the index. " + "If this parameter is not set the index is hold in the main memory.");
/**
* Parameter to specify the size of a page in bytes, must be an integer
* greater than 0.
* <p>
* Default value: {@code 4000}
* </p>
* <p>
* Key: {@code -treeindex.pagesize}
* </p>
*/
public static final OptionID PAGE_SIZE_ID = OptionID.getOrCreateOptionID("treeindex.pagesize", "The size of a page in bytes.");
/**
* Parameter to specify the size of the cache in bytes, must be an integer
* equal to or greater than 0.
* <p>
* Default value: {@link Integer#MAX_VALUE}
* </p>
* <p>
* Key: {@code -treeindex.cachesize}
* </p>
*/
public static final OptionID CACHE_SIZE_ID = OptionID.getOrCreateOptionID("treeindex.cachesize", "The size of the cache in bytes.");
/**
* Holds the name of the file storing the index specified by {@link #FILE_ID},
* null if {@link #FILE_ID} is not specified.
*/
protected String fileName = null;
/**
* Holds the value of {@link #PAGE_SIZE_ID}.
*/
protected int pageSize;
/**
* Holds the value of {@link #CACHE_SIZE_ID}.
*/
protected long cacheSize;
/**
* Constructor.
*
* @param fileName
* @param pageSize
* @param cacheSize
*/
public TreeIndexFactory(String fileName, int pageSize, long cacheSize) {
super();
this.fileName = fileName;
this.pageSize = pageSize;
this.cacheSize = cacheSize;
}
/**
* Make the page file for this index.
*
* @param <N> page type
* @param cls Class information
* @return Page file
*/
// FIXME: make this single-shot when filename is set!
protected <N extends Page> PageFile<N> makePageFile(Class<N> cls) {
final PageFile<N> inner;
if(fileName == null) {
inner = new MemoryPageFile<N>(pageSize);
}
else {
inner = new PersistentPageFile<N>(pageSize, fileName, cls);
}
if(cacheSize >= Integer.MAX_VALUE) {
return inner;
}
return new LRUCache<N>(cacheSize, inner);
}
@Override
abstract public I instantiate(Relation<O> relation);
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static abstract class Parameterizer<O> extends AbstractParameterizer {
protected String fileName = null;
protected int pageSize;
protected long cacheSize;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
FileParameter FILE_PARAM = new FileParameter(FILE_ID, FileParameter.FileType.OUTPUT_FILE, true);
if(config.grab(FILE_PARAM)) {
fileName = FILE_PARAM.getValue().getPath();
}
else {
fileName = null;
}
final IntParameter PAGE_SIZE_PARAM = new IntParameter(PAGE_SIZE_ID, new GreaterConstraint(0), 4000);
if(config.grab(PAGE_SIZE_PARAM)) {
pageSize = PAGE_SIZE_PARAM.getValue();
}
LongParameter CACHE_SIZE_PARAM = new LongParameter(CACHE_SIZE_ID, new GreaterEqualConstraint(0), Integer.MAX_VALUE);
if(config.grab(CACHE_SIZE_PARAM)) {
cacheSize = CACHE_SIZE_PARAM.getValue();
}
}
@Override
protected abstract TreeIndexFactory<O, ?> makeInstance();
}
}
|
