summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/database/query/DoubleDistanceResultPair.java
blob: ed0b7599e4cee82c81b2af32d68f62325c870a86 (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
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
package de.lmu.ifi.dbs.elki.database.query;
/*
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.ids.DBID;
import de.lmu.ifi.dbs.elki.distance.distancevalue.DoubleDistance;

/**
 * Optimized DistanceResultPair that avoids/postpones an extra layer of boxing
 * for double values.
 * 
 * @author Erich Schubert
 */
public class DoubleDistanceResultPair implements DistanceResultPair<DoubleDistance> {
  /**
   * Distance value
   */
  double distance;

  /**
   * Object ID
   */
  DBID id;

  /**
   * Constructor.
   * 
   * @param distance Distance value
   * @param id Object ID
   */
  public DoubleDistanceResultPair(double distance, DBID id) {
    super();
    this.distance = distance;
    this.id = id;
  }

  @Override
  public DoubleDistance getDistance() {
    return new DoubleDistance(distance);
  }

  @Override
  public void setDistance(DoubleDistance distance) {
    this.distance = distance.doubleValue();
  }

  @Override
  public DBID getDBID() {
    return id;
  }

  @Override
  public void setID(DBID id) {
    this.id = id;
  }

  /**
   * @deprecated Use {@link #getDoubleDistance} or {@link #getDistance} for clearness.
   */
  @Deprecated
  @Override
  public DoubleDistance getFirst() {
    return getDistance();
  }

  /**
   * @deprecated Use {@link #getDBID} for clearness.
   */
  @Deprecated
  @Override
  public DBID getSecond() {
    return id;
  }

  @Override
  public int compareByDistance(DistanceResultPair<DoubleDistance> o) {
    if(o instanceof DoubleDistanceResultPair) {
      DoubleDistanceResultPair od = (DoubleDistanceResultPair) o;
      final int delta = Double.compare(distance, od.distance);
      if(delta != 0) {
        return delta;
      }
    }
    else {
      final int delta = Double.compare(distance, o.getDistance().doubleValue());
      if(delta != 0) {
        return delta;
      }
    }
    return 0;
  }

  @Override
  public int compareTo(DistanceResultPair<DoubleDistance> o) {
    final int delta = this.compareByDistance(o);
    if(delta != 0) {
      return delta;
    }
    return id.compareTo(o.getDBID());
  }

  @Override
  public boolean equals(Object obj) {
    if(!(obj instanceof DistanceResultPair)) {
      return false;
    }
    if(obj instanceof DoubleDistanceResultPair) {
      DoubleDistanceResultPair ddrp = (DoubleDistanceResultPair) obj;
      return distance == ddrp.distance && id.equals(ddrp.id);
    }
    DistanceResultPair<?> other = (DistanceResultPair<?>) obj;
    return other.getDistance().equals(distance) && id.equals(other.getDBID());
  }

  /**
   * Get the distance as double value.
   * 
   * @return distance value
   */
  public double getDoubleDistance() {
    return distance;
  }

  @Override
  public String toString() {
    return "DistanceResultPair(" + distance + ", " + id + ")";
  }
}