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
|
/**
* Database object identification and ID group handling <em>API</em>.
*
* Database IDs (short: DBID) in ELKI are based on the factory pattern, to allow replacing
* the simple Integer-based DBIDs with more complex implementations, e.g. for use with external
* databases or to add tracking for debugging purposes. This also allows adding of more efficient
* implementations later on in a single place.
*
* <h2>DBID interface:</h2>
*
* The {@link de.lmu.ifi.dbs.elki.database.ids.DBID DBID} object identifies a single object.
*
* The {@link de.lmu.ifi.dbs.elki.database.ids.DBIDs DBIDs} hierarchy contains classes for handling groups (sets, arrays) of IDs, that can
* be seen as a two-dimensional matrix consisting
* <table style="border: 1px">
* <tr>
* <th></th>
* <th style="border-bottom: 2px">{@link de.lmu.ifi.dbs.elki.database.ids.ArrayDBIDs ArrayDBIDs}</th>
* <th style="border-bottom: 2px">{@link de.lmu.ifi.dbs.elki.database.ids.HashSetDBIDs HashSetDBIDs}</th>
* </tr>
* <tr>
* <th style="border-right: 2px">{@link de.lmu.ifi.dbs.elki.database.ids.ModifiableDBIDs ModifiableDBIDs}</th>
* <td>{@link de.lmu.ifi.dbs.elki.database.ids.ArrayModifiableDBIDs ArrayModifiableDBIDs}</td>
* <td>{@link de.lmu.ifi.dbs.elki.database.ids.HashSetModifiableDBIDs HashSetModifiableDBIDs}</td>
* </tr>
* <tr>
* <th style="border-right: 2px">{@link de.lmu.ifi.dbs.elki.database.ids.StaticDBIDs StaticDBIDs}</th>
* <td>{@link de.lmu.ifi.dbs.elki.database.ids.ArrayStaticDBIDs ArrayStaticDBIDs}</td>
* <td>n/a</td>
* </tr>
* </table>
*
* {@link de.lmu.ifi.dbs.elki.database.ids.StaticDBIDs StaticDBIDs} are structures that cannot support
* modifications, but thus can be implemented more efficiently, for example as Interval. They are
* mostly used by the data sources.
*
* These interfaces cannot be instantiated, obviously. Instead, use the static
* {@link de.lmu.ifi.dbs.elki.database.ids.DBIDFactory#FACTORY DBIDFactory.FACTORY}, which is also wrapped in the {@link de.lmu.ifi.dbs.elki.database.ids.DBIDUtil DBIDUtil} class.
*
* <h2>Examples:</h2>
* <pre>{@code
* DBIDs allids = database.getIDs();
* // preallocate an array of initial capacity 123
* ArrayModifiableDBIDs array = DBIDUtil.newArraySet(123);
* // new DBID hash set with minimum initial capacity
* ModifiableDBIDs hash = DBIDUtil.newHashSet();
*
* // add all DBIDs from the hash
* tree.addDBIDs(hash)
* }</pre>
*
* <h2>Utility functions:</h2>
* <ul>
* <li>{@link de.lmu.ifi.dbs.elki.database.ids.DBIDUtil#ensureArray DBIDUtil.ensureArray} to ensure {@link de.lmu.ifi.dbs.elki.database.ids.ArrayDBIDs ArrayDBIDs}</li>
* <li>{@link de.lmu.ifi.dbs.elki.database.ids.DBIDUtil#ensureModifiable DBIDUtil.ensureModifiable} to ensure {@link de.lmu.ifi.dbs.elki.database.ids.ModifiableDBIDs ModifiableDBIDS}</li>
* <li>{@link de.lmu.ifi.dbs.elki.database.ids.DBIDUtil#makeUnmodifiable DBIDUtil.makeUnmodifiable} to wrap DBIDs unmodifiable ({@link de.lmu.ifi.dbs.elki.database.ids.generic.UnmodifiableDBIDs UnmodifiableDBIDs}</li>
* </ul>
*
* <h2>Generic utility classes:</h2>
* <p>{@link de.lmu.ifi.dbs.elki.database.ids.generic.MergedDBIDs MergedDBIDs}
* allows virtual concatenation of multiple DBIDs objects.</p>
*
* <p>{@link de.lmu.ifi.dbs.elki.database.ids.generic.MaskedDBIDs MaskedDBIDs}
* allows masking an ArrayDBIDs with a BitSet.</p>
*
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.ids.DBIDFactory
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.ids.integer.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.ids.generic.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.ids.EmptyDBIDs.EmptyDBIDIterator
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.*Database
* @apiviz.exclude de.lmu.ifi.dbs.elki.data.Cluster
* @apiviz.exclude de.lmu.ifi.dbs.elki.utilities.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.datasource.filter.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.database.query.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.distance.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.index.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.result.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.persistent.*
* @apiviz.exclude de.lmu.ifi.dbs.elki.algorithm.*
* @apiviz.exclude java.*
*/
/*
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/>.
*/
package de.lmu.ifi.dbs.elki.database.ids;
|
