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
|
package de.lmu.ifi.dbs.elki.distance.distancefunction;
/*
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/>.
*/
import java.util.Random;
import de.lmu.ifi.dbs.elki.database.ids.DBIDRef;
import de.lmu.ifi.dbs.elki.distance.distancevalue.DoubleDistance;
import de.lmu.ifi.dbs.elki.utilities.Util;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
/**
* This is a dummy distance providing random values (obviously not metrical),
* useful mostly for unit tests and baseline evaluations: obviously this
* distance provides no benefit whatsoever.
*
* This distance is based on the combined hash codes of the two objects queried,
* if they are different. Extra caution is done to ensure symmetry and objects
* with the same ID will have a distance of 0. Obviously this distance is not
* metrical.
*
* @author Erich Schubert
*/
public class RandomStableDistanceFunction extends AbstractDBIDDistanceFunction<DoubleDistance> {
// TODO: add seed parameter!
/**
* Static instance
*/
public static final RandomStableDistanceFunction STATIC = new RandomStableDistanceFunction((new Random()).nextLong());
/**
* Seed for reproducible random.
*/
private long seed;
/**
* Constructor. Usually it is preferred to use the static instance!
*/
public RandomStableDistanceFunction(long seed) {
super();
this.seed = seed;
}
@Override
public DoubleDistance distance(DBIDRef o1, DBIDRef o2) {
int c = o1.compareDBID(o2);
if(c == 0) {
return DoubleDistance.FACTORY.nullDistance();
}
// Symmetry
if(c > 0) {
return distance(o2, o1);
}
return new DoubleDistance(pseudoRandom(seed, Util.mixHashCodes(o1.getDBID().hashCode(), o2.getDBID().hashCode(), (int) seed)));
}
/**
* Pseudo random number generator, adaption of the common rand48 generator
* which can be found in C (man drand48), Java and attributed to Donald Knuth.
*
* @param seed Seed value
* @param input Input code
*
* @return Pseudo random double value
*/
private double pseudoRandom(final long seed, int input) {
// Default constants from "man drand48"
final long mult = 0x5DEECE66DL;
final long add = 0xBL;
final long mask = (1L << 48) - 1; // 48 bit
// Produce an initial seed each
final long i1 = (input ^ seed ^ mult) & mask;
final long i2 = (input ^ (seed >>> 16) ^ mult) & mask;
// Compute the first random each
final long l1 = (i1 * mult + add) & mask;
final long l2 = (i2 * mult + add) & mask;
// Use 53 bit total:
final int r1 = (int) (l1 >>> 22); // 48 - 22 = 26
final int r2 = (int) (l2 >>> 21); // 48 - 21 = 27
double random = ((((long) r1) << 27) + r2) / (double) (1L << 53);
return random;
}
@Override
public DoubleDistance getDistanceFactory() {
return DoubleDistance.FACTORY;
}
@Override
public String toString() {
return "RandomDistance";
}
@Override
public boolean equals(Object obj) {
if(obj == null) {
return false;
}
if(!this.getClass().equals(obj.getClass())) {
return false;
}
return this.seed == ((RandomStableDistanceFunction) obj).seed;
}
@Override
public int hashCode() {
return (int) seed;
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
@Override
protected RandomStableDistanceFunction makeInstance() {
return RandomStableDistanceFunction.STATIC;
}
}
}
|
