summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/distance/distanceresultlist/DistanceDBIDResultUtil.java
blob: d1564fd8f82842f3209ecebbd72a799f62597707 (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
package de.lmu.ifi.dbs.elki.distance.distanceresultlist;

/*
 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/>.
 */
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import de.lmu.ifi.dbs.elki.database.ids.DBIDUtil;
import de.lmu.ifi.dbs.elki.database.ids.distance.DistanceDBIDList;
import de.lmu.ifi.dbs.elki.database.ids.distance.DistanceDBIDPair;
import de.lmu.ifi.dbs.elki.database.ids.distance.DistanceDBIDListIter;
import de.lmu.ifi.dbs.elki.distance.distancevalue.DoubleDistance;

/**
 * Utility classes for distance DBID results.
 * 
 * @author Erich Schubert
 * 
 * @apiviz.uses DistanceDBIDPair oneway - -
 */
public final class DistanceDBIDResultUtil {
  /**
   * Get a comparator to sort by distance, then DBID
   * 
   * @return comparator
   */
  @SuppressWarnings("unchecked")
  public static <D extends DistanceDBIDPair<?>> Comparator<? super D> distanceComparator() {
    return (Comparator<D>) BY_DISTANCE_THEN_DBID;
  }

  /**
   * Sort a Java list by distance.
   * 
   * @param list List to sort
   */
  @SuppressWarnings("unchecked")
  public static <D extends DistanceDBIDPair<?>> void sortByDistance(List<? extends D> list) {
    Collections.sort(list, (Comparator<D>) BY_DISTANCE_THEN_DBID);
  }

  /**
   * Static comparator.
   */
  private static final Comparator<DistanceDBIDPair<?>> BY_DISTANCE_THEN_DBID = new Comparator<DistanceDBIDPair<?>>() {
    @SuppressWarnings("unchecked")
    @Override
    public int compare(DistanceDBIDPair<?> o1, DistanceDBIDPair<?> o2) {
      final int d = ((DistanceDBIDPair<DoubleDistance>)o1).compareByDistance((DistanceDBIDPair<DoubleDistance>)o2);
      return (d == 0) ? DBIDUtil.compare(o1, o2) : d;
    }
  };

  /**
   * Static comparator for heaps.
   */
  public static final Comparator<DistanceDBIDPair<?>> BY_REVERSE_DISTANCE = new Comparator<DistanceDBIDPair<?>>() {
    @SuppressWarnings("unchecked")
    @Override
    public int compare(DistanceDBIDPair<?> o1, DistanceDBIDPair<?> o2) {
      return -((DistanceDBIDPair<DoubleDistance>)o1).compareByDistance((DistanceDBIDPair<DoubleDistance>)o2);
    }
  };

  public static String toString(DistanceDBIDList<?> res) {
    StringBuilder buf = new StringBuilder();
    buf.append('[');
    DistanceDBIDListIter<?> iter = res.iter();
    for(; iter.valid(); iter.advance()) {
      if(buf.length() > 1) {
        buf.append(',').append(' ');
      }
      buf.append(iter.getDistancePair().toString());
    }
    buf.append(']');
    return buf.toString();
  }
}